o ڃ@stdZddlmZddlmZddlmZddlZddlZddlmZddlm Z ddl m Z dd l m Z ddl Z Gd d d eZGd d d eZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGd d!d!eZGd"d#d#eZGd$d%d%eZGd&d'd'eZGd(d)d)eZdS)*z@Contains object representations of the JSON data for components.)absolute_import)division)unicode_literalsN)config)log) platforms)semverc@eZdZdZdS)Errorz&Base exception for the schemas module.N__name__ __module__ __qualname____doc__rr@/tmp/google-cloud-sdk/lib/googlecloudsdk/core/updater/schemas.pyr !r c@r ) ParseErrorz8An error for when a component snapshot cannot be parsed.Nr rrrrr&rrc@sJeZdZdZddZddZddZdd d Z dd d ZdddZ d S)DictionaryParserz:A helper class to parse elements out of a JSON dictionary.cCs||_||_i|_dS)zInitializes the parser. Args: cls: class, The class that is doing the parsing (used for error messages). dictionary: dict, The JSON dictionary to parse. N)_DictionaryParser__cls_DictionaryParser__dictionary_DictionaryParser__args)selfcls dictionaryrrr__init__.s zDictionaryParser.__init__cC|jS)zGets the dictionary of all parsed arguments. Returns: dict, The dictionary of field name to value for all parsed arguments. )rrrrrArgs9szDictionaryParser.ArgscCs.|r||jvrtd||j|j||S)Nz2Required field [{0}] not found while parsing [{1}])rrformatrget)rfielddefaultrequiredrrr_GetAs  zDictionaryParser._GetFNcCsN||||}|dur t|trtdj||jd|r ||}||j|<dS)aFParses a single element out of the dictionary. Args: field: str, The name of the field to parse. required: bool, If the field must be present or not (False by default). default: str or dict, The value to use if a non-required field is not present. func: An optional function to call with the value before returning (if value is not None). It takes a single parameter and returns a single new value to be used instead. Raises: ParseError: If a required field is not found or if the field parsed is a list. NzDDid not expect a list for field [{field}] in component [{component}])r! component)r$ isinstancelistrrrrrr!r#r"funcvaluerrrParseGs zDictionaryParser.Parsecs^||||}|r"t|tstd||jr"fdd|D}|r(t|n||j|<dS)aParses a element out of the dictionary that is a list of items. Args: field: str, The name of the field to parse. required: bool, If the field must be present or not (False by default). default: str or dict, The value to use if a non-required field is not present. func: An optional function to call with each value in the parsed list before returning (if the list is not None). It takes a single parameter and returns a single new value to be used instead. sort: bool, sort parsed list when it represents an unordered set. Raises: ParseError: If a required field is not found or if the field parsed is not a list. z2Expected a list for field [{0}] in component [{1}]cg|]}|qSrr.0vr)rr yz.DictionaryParser.ParseList..N)r$r&r'rrrsortedr)rr!r#r"r)sortr*rr0r ParseListas  zDictionaryParser.ParseListcs\||||}|r't|tstd||jr'tfddt|D}||j|<dS)apParses a element out of the dictionary that is a dictionary of items. Most elements are dictionaries but the difference between this and the normal Parse method is that Parse interprets the value as an object. Here, the value of the element is a dictionary of key:object where the keys are unknown. Args: field: str, The name of the field to parse. required: bool, If the field must be present or not (False by default). default: str or dict, The value to use if a non-required field is not present. func: An optional function to call with each value in the parsed dict before returning (if the dict is not empty). It takes a single parameter and returns a single new value to be used instead. Raises: ParseError: If a required field is not found or if the field parsed is not a dict. z2Expected a dict for field [{0}] in component [{1}]c3 |] \}}||fVqdSNrr.kr/r0rr z-DictionaryParser.ParseDict..N) r$r&dictrrrsix iteritemsrr(rr0r ParseDict|s  zDictionaryParser.ParseDict)FNN)FNNF) r r rrrrr$r+r5r?rrrrr+s   rc@sJeZdZdZddZeddZdddZdd d Zdd d Z d dZ dS)DictionaryWriterz=Class to help writing these objects back out to a dictionary.cCs||_i|_dSr7)_DictionaryWriter__obj_DictionaryWriter__dictionary)robjrrrr zDictionaryWriter.__init__csfdd}|S)Ncs|durdSt|Sr7)getattr)rCattribrrInners z/DictionaryWriter.AttributeGetter..Innerr)rGrHrrFrAttributeGetters z DictionaryWriter.AttributeGetterNcCs2t|j|}|dur dS|r||}||j|<dS)afWrites the given field to the dictionary. This gets the value of the attribute named field from self, and writes that to the dictionary. The field is not written if the value is not set. Args: field: str, The field name. func: An optional function to call on the value of the field before writing it to the dictionary. N)rErArB)rr!r)r*rrrWrites zDictionaryWriter.Writecs*d}r fdd}|}|j||ddS)akWrites the given list field to the dictionary. This gets the value of the attribute named field from self, and writes that to the dictionary. The field is not written if the value is not set. Args: field: str, The field name. func: An optional function to call on each value in the list before writing it to the dictionary. Ncsfdd|DS)Ncr,rrr-r0rrr1r2zBDictionaryWriter.WriteList..ListMapper..rvaluesr0rr ListMappersz.DictionaryWriter.WriteList..ListMapperr0rJ)rr!r) list_funcrMrr0r WriteLists   zDictionaryWriter.WriteListcs*fdd}r |nd}|j||ddS)akWrites the given dict field to the dictionary. This gets the value of the attribute named field from self, and writes that to the dictionary. The field is not written if the value is not set. Args: field: str, The field name. func: An optional function to call on each value in the dict before writing it to the dictionary. cstfddt|DS)Nc3r6r7rr8r0rrr:r;zADictionaryWriter.WriteDict..DictMapper..)r<r=r>rKr0rr DictMappersz.DictionaryWriter.WriteDict..DictMapperNr0rN)rr!r)rQ dict_funcrr0r WriteDicts zDictionaryWriter.WriteDictcCrr7)rBrrrr DictionaryszDictionaryWriter.Dictionaryr7) r r rrr staticmethodrIrJrPrSrTrrrrr@s     r@c@,eZdZdZeddZddZddZdS) ComponentDetailszEncapsulates some general information about the component. Attributes: display_name: str, The user facing name of the component. description: str, A little more details about what the component does. cC8t||}|jddd|jddd|di|S)N display_nameTr# descriptionrrr+rrrprrrFromDictionary zComponentDetails.FromDictionarycC$t|}|d|d|S)NrYr[r@rJrTrwrrr ToDictionary  zComponentDetails.ToDictionarycC||_||_dSr7)rYr[)rrYr[rrrrrDzComponentDetails.__init__Nr r rr classmethodr_rerrrrrrWs   rWc@rV) ComponentVersionzVersion information for the component. Attributes: build_number: int, The unique, monotonically increasing version of the component. version_string: str, The user facing version for the component. cCrX)N build_numberTrZversion_stringrr\r]rrrr_r`zComponentVersion.FromDictionarycCra)Nrkrlrbrcrrrre rfzComponentVersion.ToDictionarycCrgr7)rkrl)rrkrlrrrrrDzComponentVersion.__init__Nrhrrrrrjs   rjc@rV) ComponentDataaInformation on the data source for the component. Attributes: type: str, The type of the source of this data (i.e. tar). source: str, The hosted location of the component. size: int, The size of the component in bytes. checksum: str, The hex digest of the archive file. contents_checksum: str, The hex digest of the contents of all files in the archive. cCsVt||}|jddd|jddd|d|d|d|di|S) NtypeTrZsourcesizechecksumcontents_checksumrr\r]rrrr_$s    zComponentData.FromDictionarycCBt|}|d|d|d|d|d|S)Nrnrorprqrrrbrcrrrre.s     zComponentData.ToDictionarycC"||_||_||_||_||_dSr7)rnrorprqrr)rrnrorprqrrrrrr8s  zComponentData.__init__Nrhrrrrrms   rmc@sDeZdZdZeddZddZddZdd Zd d Z d d Z dS)ComponentPlatformaInformation on the applicable platforms for the component. Attributes: operating_systems: [platforms.OperatingSystem], The operating systems this component is valid on. If [] or None, it is valid on all operating systems. architectures: [platforms.Architecture], The architectures this component is valid on. If [] or None, it is valid on all architectures. cCs@t||}|jdddd|jdddd|di|S) z=Parses operating_systems and architectures from a dictionary.operating_systemscStjj|ddSNF)error_on_unknown)rOperatingSystemFromIdr*rrrXz2ComponentPlatform.FromDictionary..r0 architecturescSrwrx)r Architecturer{r|rrrr}[r~Nr)rr5rr]rrrr_Ks  z ComponentPlatform.FromDictionarycCs8t|}|jdtdd|jdtdd|S)Nrvidr0r)r@rPrIrTrcrrrre_s zComponentPlatform.ToDictionarycCs0|o t|ddd|_|ot|ddd|_dS)aOCreates a new ComponentPlatform. Args: operating_systems: list(platforms.OperatingSystem), The OSes this component should be installed on. None indicates all OSes. architectures: list(platforms.Architecture), The processor architectures this component works on. None indicates all architectures. cS|durd|fSd|fSNrrxrrrr}qz,ComponentPlatform.__init__..)keycSrrrrrrrr}srN)r3rvr)rrvrrrrrfs   zComponentPlatform.__init__cCsP|sd\}}n|j|j}}|jr|r||jvrdS|jr&|r$||jvr&dSdS)a6Determines if the platform for this component matches the environment. For both operating system and architecture, it is a match if: - No filter is given (regardless of platform value) - A filter is given but the value in platform matches one of the values in the filter. It is a match iff both operating system and architecture match. Args: platform: platform.Platform, The platform that must be matched. None will match only platform-independent components. Returns: True if it matches or False if not. )NNFT)operating_system architecturervr)rplatformmy_osmy_archrrrMatchesus zComponentPlatform.MatchescCs ||j|jo||j|jS)aIDetermines if this platform intersects with the other platform. Platforms intersect if they can both potentially be installed on the same system. Args: other: ComponentPlatform, The other component platform to compare against. Returns: bool, True if there is any intersection, False otherwise. )(_ComponentPlatform__CollectionsIntersectrvr)rotherrrrIntersectsWiths z ComponentPlatform.IntersectsWithcCs|r|sdSt|t|@S)alDetermines if the two collections intersect. The collections intersect if either or both are None or empty, or if they contain an intersection of elements. Args: collection1: [] or None, The first collection. collection2: [] or None, The second collection. Returns: bool, True if there is an intersection, False otherwise. T)set)r collection1 collection2rrr__CollectionsIntersectsz(ComponentPlatform.__CollectionsIntersectN) r r rrrir_rerrrrrrrrru@s # ruc@rV) ComponentaData type for an entire component. Attributes: id: str, The unique id for this component. details: ComponentDetails, More descriptions of the components. version: ComponentVersion, Information about the version of this component. is_hidden: bool, True if this should be hidden from the user. is_required: bool, True if this component must always be installed. gdu_only: bool, True if this component is only available in GDU. is_configuration: bool, True if this should be displayed in the packages section of the component manager. data: ComponentData, Information about where to get the component from. platform: ComponentPlatform, Information about what operating systems and architectures the compoonent is valid on. dependencies: [str], The other components required by this one. platform_required: bool, True if a platform-specific executable is required. cCst||}|jddd|jddtjd|jddtjd|jddd |jd dd |jd dd |jd dd |jd tjd|jditjd|jdgdd|jddd |di|S)zConverts a dictionary object to an instantiated Component class. Args: dictionary: The Dictionary to to convert from. Returns: A Component object initialized from the dictionary object. rTrZdetailsr#r)version is_hiddenFr" is_requiredgdu_onlyis_configurationdatar0rr"r) dependencies)r"r4platform_requiredNr) rr+rWr_rjrmrur5rr]rrrr_s zComponent.FromDictionarycCst|}|d|jdtjd|jdtjd|d|d|d|d|jd tjd|jd tjd|d |d |S) wConverts a Component object to a Dictionary object. Returns: A Dictionary object initialized from self. rrr0rrrrrrrrr) r@rJrWrerjrmrurPrTrcrrrres       zComponent.ToDictionaryc CsF||_||_||_||_||_||_| |_| |_||_||_ | |_ dSr7) rrrrrrrrrrr) rrrrrrrrrrrrrrrrs zComponent.__init__Nrhrrrrrs   rc@4eZdZdZeddZddZddZdd Zd S) Notificationa3Data type for a update notification's notification object. Attributes: annotation: str, A message to print before the normal update message. update_to_version: str, A version string to tell the user to update to. custom_message: str, An alternate message to print instead of the usual one. cCs:t||}|d|d|d|di|S)zConverts a dictionary object to an instantiated Notification class. Args: dictionary: The Dictionary to to convert from. Returns: A Notification object initialized from the dictionary object. annotationupdate_to_versioncustom_messageNrr\r]rrrr_s   zNotification.FromDictionarycCs.t|}|d|d|d|S)zzConverts a Notification object to a Dictionary object. Returns: A Dictionary object initialized from self. rrrrbrcrrrre's    zNotification.ToDictionarycCs||_||_||_dSr7)rrr)rrrrrrrr3s zNotification.__init__cCsT|jr|j}n|jr|jdnd}|jrd|j}nd}|dj|d7}d|dS)zGets the notification message to print to the user. Returns: str, The notification message the user should see. z z --version zUpdates are available for some Google Cloud CLI components. To install them, please run: $ gcloud components update{version})r)rrrr)rmsgrlrrrNotificationMessage8s  z Notification.NotificationMessageN) r r rrrir_rerrrrrrrs  rc@s:eZdZdZdZeddZddZddZd d d Z d S) Triggera.Data type for a update notification's trigger object. Attributes: frequency: int, The number of seconds between notifications. command_regex: str, A regular expression to match a command name. The notification will only trigger when running a command that matches this regex. iQcCs6t||}|jdtjd|d|di|S)zConverts a dictionary object to an instantiated Trigger class. Args: dictionary: The Dictionary to to convert from. Returns: A Condition object initialized from the dictionary object. frequencyr command_regexNr)rr+rDEFAULT_NAG_FREQUENCYrr]rrrr_Ys  zTrigger.FromDictionarycCra)zuConverts a Trigger object to a Dictionary object. Returns: A Dictionary object initialized from self. rrrbrcrrrrehs  zTrigger.ToDictionarycCrgr7)rr)rrrrrrrsrDzTrigger.__init__NcCs:t||jkr dS|jr|sdSt|j|sdSdS)apDetermine if this trigger matches and the notification should be printed. Args: last_nag_time: int, The time we last printed this notification in seconds since the epoch. command_path: str, The name of the command currently being run (i.e. gcloud.components.list). Returns: True if the trigger matches, False otherwise. FT)timerrrematch)r last_nag_time command_pathrrrrws zTrigger.Matchesr7) r r rrrrir_rerrrrrrrNs  rc@r) ConditionaData type for a update notification's condition object. Attributes: start_version: str, The current version of the SDK must be great than or equal to this version in order to activate the notification. end_version: str, The current version of the SDK must be less than or equal to this version in order to activate the notification. version_regex: str, A regex to match the current version of the SDK to activate this notification. age: int, The number of seconds old this SDK version must be to activate this notification. check_component: bool, True to require that component updates are actually present to activate this notification, False to skip this check. cCsRt||}|d|d|d|d|jddd|d i|S) zConverts a dictionary object to an instantiated Condition class. Args: dictionary: The Dictionary to to convert from. Returns: A Condition object initialized from the dictionary object. start_version end_version version_regexagecheck_componentsTrNrr\r]rrrr_s    zCondition.FromDictionarycCrs)rrrrrrrbrcrrrres     zCondition.ToDictionarycCrtr7)rrrrr)rrrrrrrrrrs  zCondition.__init__cCs|dur|js |js |jrdSz$|jr!t|t|jkr!WdS|jr2t|t|jkr2WdSWntjyEtjdddYdSw|jrRt |j|sRdS|j dur|dur]dSzt }t j |}|||j krrWdSWntytjdddYdSw|jr|sdSdS)aqDetermines if this notification should be activated for this SDK. Args: current_version: str, The installed version of the SDK (i.e. 1.2.3) current_revision: long, The revision (from the component snapshot) that is currently installed. This is a long int but formatted as an actual date in seconds (i.e 20151009132504). It is *NOT* seconds since the epoch. component_updates_available: bool, True if there are updates available for some components that are currently installed. Returns: True if the notification should be activated, False to ignore it. NFz/Failed to parse semver, condition not matching.T)exc_infoz1Failed to parse revision, condition not matching.)rrrrSemVerrrdebugrrrrrInstallationConfigParseRevisionAsSeconds ValueErrorr)rcurrent_versioncurrent_revisioncomponent_updates_availablenow last_updatedrrrrsX   zCondition.MatchesN) r r rrrir_rerrrrrrrs  rc@rV) NotificationSpecaData type for a update notification object. Attributes: condition: Condition, The settings for whether or not this notification should be activated by a particular installation. trigger: Trigger, The settings for whether to trigger an activated notification on a particular command execution. notification: Notification, The settings about how to actually express the notification to the user once it is triggered. cCs`t||}|jddd|jditjd|jditjd|jditjd|d i|S) zConverts a dictionary object to an instantiated NotificationSpec class. Args: dictionary: The Dictionary to to convert from. Returns: A NotificationSpec object initialized from the dictionary object. rTrZ conditionrtrigger notificationNr)rr+rr_rrrr]rrrr_s zNotificationSpec.FromDictionarycCsJt|}|d|jdtjd|jdtjd|jdtjd|S)rrrr0rr)r@rJrrerrrTrcrrrre"s  zNotificationSpec.ToDictionarycC||_||_||_||_dSr7)rrrr)rrrrrrrrr0 zNotificationSpec.__init__Nrhrrrrrs   rc@rV) SchemaVersionaInformation about the schema version of this snapshot file. Attributes: version: int, The schema version number. A different number is considered incompatible. no_update: bool, True if this installation should not attempted to be updated. message: str, A message to display to the user if they are updating to this new schema version. url: str, The URL to grab a fresh Cloud SDK bundle. cCsPt||}|jddd|jddd|d|jddd|d i|S) NrTrZ no_updateFrmessageurlrr\r]rrrr_Ds  zSchemaVersion.FromDictionarycCs8t|}|d|d|d|d|S)NrrrrrbrcrrrreMs     zSchemaVersion.ToDictionarycCrr7)rrrr)rrrrrrrrrUrzSchemaVersion.__init__Nrhrrrrr7s   rc@sTeZdZdZeddZeddZeddZdd Zd d Z d d Z ddZ dS) SDKDefinitiona5Top level object for then entire component snapshot. Attributes: revision: int, The unique, monotonically increasing version of the snapshot. release_notes_url: string, The URL where the latest release notes can be downloaded. version: str, The version name of this release (i.e. 1.2.3). This should be used only for informative purposes during an update (to say what version you are updating to). gcloud_rel_path: str, The path to the gcloud entrypoint relative to the SDK root. post_processing_command: str, The gcloud subcommand to run to do post-processing after an update. This will be split on spaces before being executed. components: [Component], The component definitions. notifications: [NotificationSpec], The active update notifications. cCsv||}|jddd|d|d|d|d|jddtjd |jd gtjd |d i|S) NrevisionTrZrelease_notes_urlrgcloud_rel_pathpost_processing_command componentsr notificationsrr) _ParseBaser+r5rr_rrr]rrrr_os     zSDKDefinition.FromDictionarycCs||dS)Nschema_version)rr)rrrrrr|szSDKDefinition.SchemaVersioncCs&t||}|jddddtjd|S)Nrrr)rrr)rr+rr_r]rrrrs zSDKDefinition._ParseBasecCsrt|}|d|d|d|d|d|jdtjd|jdtjd|jd tjd|S) Nrrrrrrr0rr)r@rJrrerPrrrTrcrrrres     zSDKDefinition.ToDictionaryc Cs4||_||_||_||_||_||_||_||_dSr7)rrrrrrrr) rrrrrrrrrrrrrs zSDKDefinition.__init__cCs2ztj|j}td|WStyYdSw)Nz%Y/%m/%dUnknown)rr ParseRevisionrrstrftimer)rrrrrLastUpdatedStrings  zSDKDefinition.LastUpdatedStringcCsVtdd|jD}|jD]}|j|vr"|j||j|||j<|j|q dS)Ncss|]}|j|fVqdSr7)r)r.crrrr:sz&SDKDefinition.Merge..)r<rrremoveappend)rsdk_defcurrent_componentsrrrrMerges   zSDKDefinition.MergeN) r r rrrir_rrrerrrrrrrr\s     rc@rV) LastUpdateCheckaTop level object for the cache of the last time an update check was done. Attributes: version: int, The schema version number. A different number is considered incompatible. no_update: bool, True if this installation should not attempted to be updated. message: str, A message to display to the user if they are updating to this new schema version. url: str, The URL to grab a fresh Cloud SDK bundle. cCsXt||}|jddd|jddd|jdgtjd|jdid|di|S) Nlast_update_check_timerrlast_update_check_revisionrrlast_nag_timesr)rr+r5rr_r?rr]rrrr_s zLastUpdateCheck.FromDictionarycCs>t|}|d|d|jdtjd|d|S)Nrrrr0r)r@rJrPrrerSrTrcrrrres    zLastUpdateCheck.ToDictionarycCrr7)rrrr)rrrrrrrrrs zLastUpdateCheck.__init__Nrhrrrrrs   r) r __future__rrrrrgooglecloudsdk.corerrgooglecloudsdk.core.utilrrr= Exceptionr robjectrr@rWrjrmrurrrrrrrrrrrrs6       pH(}Q@Av2%S