Method url_id

apprise/url.py:394–533

Returns a unique URL identifier that representing the Apprise URL itself. The url_id is always a hash string or None if it can't be generated. The idea is to only build the ID based on the credentials or specific elements relative to the URL itself. The URL ID should

(self, lazy=True, hash_engine=hashlib.sha256)

        )

    def url_id(self, lazy=True, hash_engine=hashlib.sha256):
        """Returns a unique URL identifier that representing the Apprise URL
        itself. The url_id is always a hash string or None if it can't be
        generated.

        The idea is to only build the ID based on the credentials or specific
        elements relative to the URL itself. The URL ID should never factor in
        (or else it's a bug) the following:
          - any targets defined
          - all GET parameters options unless they explicitly change the
            complete function of the code.

             For example: GET parameters like ?image=false&avatar=no should
             have no bearing in the uniqueness of the Apprise URL Identifier.

             Consider plugins where some get parameters completely change
             how the entire upstream comunication works such as slack:// and
             matrix:// which has a mode. In these circumstances, they should
             be considered in he unique generation.

        The intention of this function is to help align Apprise URLs that are
        common with one another and therefore can share the same persistent
        storage even when subtle changes are made to them.

        Hence the following would all return the same URL Identifier:
             json://abc/def/ghi?image=no
             json://abc/def/ghi/?test=yes&image=yes
        """

        if lazy and self.__cached_url_identifier is not False:
            return (
                self.__cached_url_identifier
                if not (
                    self.__cached_url_identifier and self.asset.storage_idlen
                )
                else self.__cached_url_identifier[: self.asset.storage_idlen]
            )

        # Python v3.9 introduces usedforsecurity argument
        kwargs = (
            {"usedforsecurity": False} if sys.version_info >= (3, 9) else {}
        )

        if self.url_identifier is False:
            # Disabled
            self.__cached_url_identifier = None

        elif self.url_identifier in (None, True):
            # Prepare our object
            engine = hash_engine(
                self.asset.storage_salt
                + self.schema.encode(self.asset.encoding),
                **kwargs,
            )

            # We want to treat `None` differently then a blank entry
            engine.update(
                b"\0"