a 'Dg" @sddlZddlZddlZddlmZmZddlmZddlm Z e e Z GdddeZ ejGdddedgd Zeeed d d Zejeeed ddZddddeeeeeee dddZddeeedddZdS)N) NamedTupleOptional)features)loggersc@seZdZUeed<eed<dS)DeprecationLogZ log_levelmessageN)__name__ __module__ __qualname__int__annotations__strrr7/usr/lib/python3.9/site-packages/cloudinit/lifecycle.pyr s rcs|eZdZdZdeeeeddfdd ZeeddddZd d Z d d Z d dZ ddZ ddZ dedddZZS)Versiona>A class for comparing versions. Implemented as a named tuple with all ordering methods. Comparisons between X.Y.N and X.Y always treats the more specific number as larger. :param major: the most significant number in a version :param minor: next greatest significant number after major :param patch: next greatest significant number after minor :param rev: the least significant number in a version :raises TypeError: If invalid arguments are given. :raises ValueError: If invalid arguments are given. Examples: >>> Version(2, 9) == Version.from_str("2.9") True >>> Version(2, 9, 1) > Version.from_str("2.9.1") False >>> Version(3, 10) > Version.from_str("3.9.9.9") True >>> Version(3, 7) >= Version.from_str("3.7") True )majorminorpatchrevreturncstt||||||S)zPDefault of -1 allows us to tiebreak in favor of the most specific number)superr__new__)clsrrrr __class__rrr/szVersion.__new__)versionrcCs|ttt|dS)a%Create a Version object from a string. :param version: A period-delimited version string, max 4 segments. :raises TypeError: Raised if invalid arguments are given. :raises ValueError: Raised if invalid arguments are given. :return: A Version object. .)listmapr split)rrrrrfrom_str6s zVersion.from_strcCsd||kS)N)_compare_versionselfotherrrr__gt__CszVersion.__gt__cCs0|j|jko.|j|jko.|j|jko.|j|jkSNrrrrr$rrr__eq__Fs    zVersion.__eq__ccs6|j|j|j|jfD]}|dkr,t|Vqq2qdS)z)Iterate over the version (drop sentinels)rN)rrrrr )r%nrrr__iter__Ns zVersion.__iter__cCs d|S)Nr)joinr%rrr__str__VszVersion.__str__cCs tt|Sr()hashr r.rrr__hash__YszVersion.__hash__)r&rcCsP||kr dS|j|jkrdS|j|jkr,dS|j|jkr other, 1 if self < other, else 0 rr"rr)r$rrrr#\s    zVersion._compare_version)rrrr)rr r __doc__r r classmethodr r!r'r*r,r/r1r# __classcell__rrrrrs rr))rboundary_versionrcCs|dkpt|t|kS)a Determine if a deprecation message should be logged. :param version: The version in which the thing was deprecated. :param boundary_version: The version at which deprecation level is logged. :return: True if the message should be logged, else False. Zdevel)rr!)rr5rrrshould_log_deprecationps  r6)loggerrrequested_levelmsgcCs,t|tjr||||n |||dS)auLog a message at the requested level, if that is acceptable. If the log level is too high due to the version boundary, log at DEBUG level. Useful to add new warnings to previously unguarded code without disrupting stable downstreams. :param logger: Logger object to log with :param version: Version string of the version that this log was introduced :param level: Preferred level at which this message should be logged :param msg: Message, as passed to the logger. :param args: Message formatting args, as passed to the logger :return: True if the message should be logged, else False. N)r6rDEPRECATION_INFO_BOUNDARYlogdebug)r7rr8r9argsrrrlog_with_downgradable_level}s r>F) extra_messagescheduleskip_log) deprecateddeprecated_versionr@rArBrc Csttdsttdt|pd}t|||t|}t|}t|j||j }|d|d|d| } t |t j stj} nttdrtj} ntj} ttd} |s|| vr| |t| | t| | S)aMark a "thing" as deprecated. Deduplicated deprecations are logged. :param deprecated: Noun to be deprecated. Write this as the start of a sentence, with no period. Version and extra message will be appended. :param deprecated_version: The version in which the thing was deprecated :param extra_message: A remedy for the user's problem. A good message will be actionable and specific (i.e., don't use a generic "Use updated key." if the user used a deprecated key). End the string with a period. :param schedule: Manually set the deprecation schedule. Defaults to 5 years. Leave a comment explaining your reason for deviation if setting this value. :param skip_log: Return log text rather than logging it. Useful for running prior to logging setup. :return: NamedTuple containing log level and log message DeprecationLog(level: int, message: str) Note: uses keyword-only arguments to improve legibility r;z is deprecated in z and scheduled to be removed in z. rC)hasattr deprecatesetattrsetr0r rr!rrrstripr6rr:loggingINFOLOGrZ DEPRECATEDZWARNgetattraddr;r) rCrDr@rArBrZdeduprZversion_removedZ deprecate_msglevelZ log_cacherrrrGs4       rG)rArDr@rAcsfdd}|S)a~Mark a "thing" as deprecated. Deduplicated deprecations are logged. :param deprecated_version: The version in which the thing was deprecated :param extra_message: A remedy for the user's problem. A good message will be actionable and specific (i.e., don't use a generic "Use updated key." if the user used a deprecated key). End the string with a period. :param schedule: Manually set the deprecation schedule. Defaults to 5 years. Leave a comment explaining your reason for deviation if setting this value. Note: uses keyword-only arguments to improve legibility cs tfdd}|S)Ncs$|i|}tjd|S)N)rDrCr@rA)rGr)r=kwargsout)rDr@funcrArr decoratorsz2deprecate_call..wrapper..decorator) functoolswraps)rTrUrQ)rTrwrappers zdeprecate_call..wrapperr)rDr@rArXrrQrdeprecate_callsrY) collectionsrVrKtypingrrZ cloudinitrZ cloudinit.logrZ getLoggerrrMrtotal_ordering namedtuplerr boolr6ZLoggerr r>rGrYrrrrs@    ]  9