Public Member Functions
None	__init__ (self, str cache_dir)

str	key (self)

Optional[str]	get (self, datetime.datetime current_time)

None	set (self, str pypi_version, datetime.datetime current_time)

Data Fields
	key

Protected Attributes
	_statefile_path

	_state

Detailed Description

Definition at line 43 of file self_outdated_check.py.

Constructor & Destructor Documentation

◆ init()

None __init__	(		self,
		str	cache_dir
	)

Definition at line 44 of file self_outdated_check.py.

    def __init__(self, cache_dir: str) -> None:
        self._state: Dict[str, Any] = {}
        self._statefile_path = None
 
        # Try to load the existing state
        if cache_dir:
            self._statefile_path = os.path.join(
                cache_dir, "selfcheck", _get_statefile_name(self.key)
            )
            try:
                with open(self._statefile_path, encoding="utf-8") as statefile:
                    self._state = json.load(statefile)
            except (OSError, ValueError, KeyError):
                # Explicitly suppressing exceptions, since we don't want to
                # error out if the cache file is invalid.
                pass
 

References SelfCheckState._state, CharSetGroupProber._state, CharSetProber._state, EscCharSetProber._state, EUCJPProber._state, Latin1Prober._state, MacRomanProber._state, MultiByteCharSetProber._state, SingleByteCharSetProber._state, SJISProber._state, UTF1632Prober._state, UTF8Prober._state, and GzipDecoder._state.

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

◆ get()

Optional[str] get	(		self,
		datetime.datetime	current_time
	)

Check if we have a not-outdated version loaded already.

Definition at line 65 of file self_outdated_check.py.

    def get(self, current_time: datetime.datetime) -> Optional[str]:
        """Check if we have a not-outdated version loaded already."""
        if not self._state:
            return None
 
        if "last_check" not in self._state:
            return None
 
        if "pypi_version" not in self._state:
            return None
 
        seven_days_in_seconds = 7 * 24 * 60 * 60
 
        # Determine if we need to refresh the state
        last_check = datetime.datetime.strptime(self._state["last_check"], _DATE_FMT)
        seconds_since_last_check = (current_time - last_check).total_seconds()
        if seconds_since_last_check > seven_days_in_seconds:
            return None
 
        return self._state["pypi_version"]
 

References SelfCheckState._state, CharSetGroupProber._state, CharSetProber._state, EscCharSetProber._state, EUCJPProber._state, Latin1Prober._state, MacRomanProber._state, MultiByteCharSetProber._state, SingleByteCharSetProber._state, SJISProber._state, UTF1632Prober._state, UTF8Prober._state, GzipDecoder._state, and i.

Referenced by LegacyMetadata.__getitem__(), Layout.__getitem__(), LegacyMetadata.check(), ThemeStack.push_theme(), and LegacyMetadata.write_file().

Here is the caller graph for this function:

◆ key()

str key ( self )

Definition at line 62 of file self_outdated_check.py.

    def key(self) -> str:
        return sys.prefix
 

References i.

Referenced by Matcher.__eq__(), Matcher.__hash__(), and SelfCheckState.set().

Here is the caller graph for this function:

◆ set()

None set	(		self,
		str	pypi_version,
		datetime.datetime	current_time
	)

Definition at line 86 of file self_outdated_check.py.

    def set(self, pypi_version: str, current_time: datetime.datetime) -> None:
        # If we do not have a path to cache in, don't bother saving.
        if not self._statefile_path:
            return
 
        # Check to make sure that we own the directory
        if not check_path_owner(os.path.dirname(self._statefile_path)):
            return
 
        # Now that we've ensured the directory is owned by this user, we'll go
        # ahead and make sure that all our directories are created.
        ensure_dir(os.path.dirname(self._statefile_path))
 
        state = {
            # Include the key so it's easy to tell which pip wrote the
            # file.
            "key": self.key,
            "last_check": current_time.strftime(_DATE_FMT),
            "pypi_version": pypi_version,
        }
 
        text = json.dumps(state, sort_keys=True, separators=(",", ":"))
 
        with adjacent_tmp_file(self._statefile_path) as f:
            f.write(text.encode())
 
        try:
            # Since we have a prefix-specific state file, we can just
            # overwrite whatever is there, no need to check.
            replace(f.name, self._statefile_path)
        except OSError:
            # Best effort.
            pass
 
 
@dataclass