o j@sfdZddlmZddlmZddlmZddlZddlZddlZddlZddl m Z ddl m Z ddl m Z dd lmZdd lmZddlZd Zd ZGd ddeZGdddeZGdddeZGdddeejeZddZddZ d3ddZddZ e ddZ!e dd Z"d!d"Z#d#d$Z$d%d&Z%d'd(Z&d)d*Z'd+d,Z(d-d.Z)d/d0Z*d1d2Z+dS)4z-Helpers to load commands from the filesystem.)absolute_import)division)unicode_literalsN)base)command_release_tracks) exceptions) pkg_resources)yaml _PARTIALS_ _partialscs eZdZdZfddZZS)CommandLoadFailurezCAn exception for when a command or group module cannot be imported.cs0||_||_tt|dj|t|ddS)Nz#Problem loading {command}: {issue}.)commandissue)r root_exceptionsuperr __init__formatsix text_type)selfr r __class__D/tmp/google-cloud-sdk/lib/googlecloudsdk/calliope/command_loading.pyr)s  zCommandLoadFailure.__init__)__name__ __module__ __qualname____doc__r __classcell__rrrrr &sr c@eZdZdZdS)LayoutExceptionzFAn exception for when a command or group .py file has the wrong types.Nrrrrrrrrr 3r c@r)#ReleaseTrackNotImplementedExceptionzJAn exception for when a command or group does not support a release track.Nr!rrrrr#7r"r#c@seZdZdZejddZdS)YamlCommandTranslatorzCAn interface to implement when registering a custom command loader.cCsdS)a;Translates a yaml command into a calliope command. Args: path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. command_data: dict, The parsed contents of the command spec from the yaml file that corresponds to the release track being loaded. Returns: calliope.base.Command, A command class (not instance) that implements the spec. Nr)rpath command_datarrr Translate>szYamlCommandTranslator.TranslateN)rrrrabcabstractmethodr'rrrrr$;sr$cCsPt|dkrtd|td|d}tj|dgd\}}t||t||fS)awFind all the sub groups and commands under this group. Args: impl_paths: [str], A list of file paths to the command implementation for this group. path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. Raises: CommandLoadFailure: If the command is invalid and cannot be loaded. LayoutException: if there is a command or group with an illegal name. Returns: ({str: [str]}, {str: [str]), A tuple of groups and commands found where each item is a mapping from name to a list of paths that implement that command or group. There can be multiple paths because a command or group could be implemented in both python and yaml (for different release tracks). .,Command groups cannot be implemented in yamlr.yaml)extra_extensions)lenr join Exceptionr ListPackage_GenerateElementInfo) impl_pathsr% impl_pathgroupscommandsrrrFindSubElementsQs  r8cCsji}|D].}td|rtd||dr|ddn|}tj||}||g}| |q|S)a&Generates the data a group needs to load sub elements. Args: impl_path: The file path to the command implementation for this group. names: [str], The names of the sub groups or commands found in the group. Raises: LayoutException: if there is a command or group with an illegal name. Returns: {str: [str], A mapping from name to a list of paths that implement that command or group. There can be multiple paths because a command or group could be implemented in both python and yaml (for different release tracks). z[A-Z]z5Commands and groups cannot have capital letters: {0}.r-N) researchr rendswithosr%r0 setdefaultappend)r5nameselementsnamecli_namesub_pathexistingrrrr3us   r3cCs"t|||||}t|d||S)aLoads a calliope command or group from a file. Args: impl_paths: [str], A list of file paths to the command implementation for this group or command. path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. release_track: ReleaseTrack, The release track that we should load. construction_id: str, A unique identifier for the CLILoader that is being constructed. is_command: bool, True if we are loading a command, False to load a group. yaml_command_translator: YamlCommandTranslator, An instance of a translator to use to load the yaml data. Raises: CommandLoadFailure: If the command is invalid and cannot be loaded. Returns: The base._Common class for the command or group. r)_GetAllImplementations"_ExtractReleaseTrackImplementation)r4r% release_trackconstruction_id is_commandyaml_command_translatorimplementationsrrrLoadCommonTypes   rMcsifdd}|S)Ncs2z|WSty|}||<|YSwN)KeyError)argsresultcached_resultsfuncrrReturnCachedOrCallFuncs  z%Cache..ReturnCachedOrCallFuncr)rTrUrrRrCachesrVcCstt|SrN)r safe_loadrGetResourceFromFiler%rrr_SafeLoadYamlFilesrZcCst|t|SrN)CreateYamlLoaderloadrrXrYrrr_CustomLoadYamlFilesr]c Csg}|D]B}|dr0|std|tdt||r"t||}nt|}|t|||qt |||}|t |j t |j |dq|S)aGets all the release track command implementations. Can load both python and yaml modules. Args: impl_paths: [str], A list of file paths to the command implementation for this group or command. path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. construction_id: str, A unique identifier for the CLILoader that is being constructed. is_command: bool, True if we are loading a command, False to load a group. yaml_command_translator: YamlCommandTranslator, An instance of a translator to use to load the yaml data. Raises: CommandLoadFailure: If the command is invalid and cannot be loaded. Returns: [(func->base._Common, [base.ReleaseTrack])], A list of tuples that can be passed to _ExtractReleaseTrackImplementation. Each item in this list represents a command implementation. The first element is a function that returns the implementation, and the second element is a list of release tracks it is valid for. r-r+r,)rJ)r<r r0r1_IsCommandWithPartials_LoadCommandWithPartialsr]extend_ImplementationsFromYaml_GetModuleFromPath_ImplementationsFromModule__file__list__dict__values) r4r%rIrJrKrL impl_filedatamodulerrrrFs.      rFcCsd}t|<}|D]0}|}|r|drq |tdkr"d}q |r2td|tdtdWd|SWd|S1sFwY|S) aChecks if the YAML file is a command with partials. Args: impl_file: file path to the main YAML command implementation. path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. Raises: CommandLoadFailure: If the command is invalid and should not be loaded. Returns: Whether or not it is a valid command with partials to load. F#z: trueTr+z Command with z$ attribute cannot have extra contentN)rGetFileTextReaderByLinestrip startswithPARTIALS_ATTRIBUTEr r0r1)rhr%found_partial_tokenfilelinerrrr^ s.    r^c Cstj|}|dd}tjtj|t}t|d|d}g}t tj|d|}|D]}t |d|rD| t |q2t |||S)a=Loads all YAML partials for a command with partials based on conventions. Partial files are loaded using _CustomLoadYamlFile as normal YAML commands. Conventions: - Partials should be placed in subfolder `_partials`. - File names of partials should match the main command name and follow this format: _[command_name]_[version|release_track].yaml - Release tracks should not be duplicatd across all partials. Args: impl_file: file path to the main YAML command implementation. path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. Returns: List with data loaded from partial YAML files for the main command. Nr9_z_*.yamlz_(alpha|beta|ga)\.yaml)r=r%basenamer0dirname PARTIALS_DIRrGetFilesFromDirectoryr:escapematchr`r]_ValidateCommandWithPartials) rhr% file_name command_name partials_dir partial_filescommand_data_list command_path partial_filerrrr_/s    r_cCsPt}|D] }|dD]}||vrtd|td|d||q qdS)aValidates that the command with partials do not have duplicated tracks. Args: command_data_list: List with data loaded from all YAML partials. path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. Raises: CommandLoadFailure: If the command is invalid and should not be loaded. release_tracksr+zMCommand with partials cannot have duplicated release tracks. Found multiple [zs]N)setr r0r1add)rr%rr&rHrrrrzUs   rzcstjtjd}dzt|Wn tyYnwGfdddtjt}|_|j j j |j j j|S)zCreates a custom yaml loader that handles includes from common data. Args: impl_path: str, The path to the file we are loading data from. Returns: yaml.Loader, A yaml loader to use. z __init__.yamlNcseZdZdZdZdZdZdZfddZdd Z fd d Z d d Z ddZ ddZ fddZddZfddZZS)z%CreateYamlLoader..Constructora,A custom yaml constructor. It adds 2 different import capabilities. Assuming __init__.yaml has the contents: foo: a: b c: d baz: - e: f - g: h The first uses a custom constructor to insert data into your current file, so: bar: !COMMON foo.a results in: bar: b The second mechanism overrides construct_mapping and construct_sequence to post process the data and replace the merge macro with keys from the other file. We can't use the custom constructor for this as well because the merge key type in yaml is processed before custom constructors which makes importing and merging not possible. So: bar: _COMMON_: foo i: j results in: bar: a: b c: d i: j This can also be used to merge list contexts, so: bar: - _COMMON_baz - i: j results in: bar: - e: f - g: h - i: j You may also use the !REF and _REF_ directives in the same way. Instead of pulling from the common file, they can pull from an arbitrary yaml file somewhere in the googlecloudsdk tree. The syntax looks like: bar: !REF googlecloudsdk.foo.bar:a.b.c This will load googlecloudsdk/foo/bar.yaml and from that file return the a.b.c nested attribute. z!COMMON_COMMON_z!REF_REF_c:t|j|i|}|j|j|}|j|j|SrN)rconstruct_mapping_ConstructMappingHelperMERGE_COMMON_MACRO_GetCommonDataMERGE_REF_MACRO _GetRefDatarrPkwargsri Constructorrrrr  z7CreateYamlLoader..Constructor.construct_mappingcSsD||d}|s |Si}|dD] }|||q|||SN,)popsplitupdate)rmacro source_funcriattribute_path modified_datar%rrrrs  z=CreateYamlLoader..Constructor._ConstructMappingHelpercrrN)rconstruct_sequence_ConstructSequenceHelperrrrrrrrrrrz8CreateYamlLoader..Constructor.construct_sequencecSsbg}|D]*}t|tjr)||r)|t|d}|dD] }|||qq||q|Sr) isinstancer string_typesrnr/rr`r?)rrrrinew_listirr%rrrrs z>CreateYamlLoader..Constructor._ConstructSequenceHelpercS||}||SrN)construct_scalarrrnoderrrr IncludeCommon  z3CreateYamlLoader..Constructor.IncludeCommoncSrrN)rrrrrr IncludeRefrz0CreateYamlLoader..Constructor.IncludeRefcs s td||dS)NzDCommand [{}] references [common command] data but it does not exist.zcommon command)r r _GetAttribute)rr) common_datar5rrrs z4CreateYamlLoader..Constructor._GetCommonDatac Ss|d}t|dkrtd||dd}z"t|d}tjjtj |j g|ddRd}t |}Wnt t fyS}z td |d|d}~ww|||d|S) aLoads the YAML data from the given reference. A YAML reference must refer to a YAML file and an attribute within that file to extract. Args: path: str, The path of the YAML file to import. It must be in the form of package.module:attribute.attribute, where the module path is separated from the sub attributes within the YAML by a ':'. Raises: LayoutException: If the given module or attribute cannot be loaded. Returns: The referenced YAML data. :zcInvalid Yaml reference: [{}]. References must be in the format: path(.path)+:attribute(.attribute)*rr+r*Nr-z+Failed to load Yaml reference file [{}]: {})rr/r r importlib import_moduler=r%r0rurdrZ ImportErrorIOErrorr)rr%parts path_segments root_module yaml_pathrierrrrs2     z1CreateYamlLoader..Constructor._GetRefDatacs<|}|dD]}||d}|std|||q|S)Nr+zTCommand [{}] references [{}] data attribute [{}] in path [{}] but it does not exist.)rgetr r)rrirlocationvalue attribute)r5rrr&s z3CreateYamlLoader..Constructor._GetAttribute)rrrrINCLUDE_COMMON_MACROrINCLUDE_REF_MACROrrrrrrrrrrrrrrr5rrrs>    (r)r=r%r0rurZrr rYAML constructoradd_constructorrrrr)r5common_file_pathloaderrrrr[qs$   3r[c Cshdj|d|ddd}zt||WSty3}zttd||WYd}~dSd}~ww)aImport the module and dig into it to return the namespace we are after. Import the module relative to the top level directory. Then return the actual module corresponding to the last bit of the path. Args: impl_file: str, The path to the file this was loaded from (for error reporting). path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. construction_id: str, A unique identifier for the CLILoader that is being constructed. Returns: The imported module. z.__calliope__command__.{construction_id}.{name}r+-rs)rIrBN) rr0replacerGetModuleFromPathr1rreraiser )rhr%rI name_to_giverrrrrb>s$rbcCsg}g}|D]}t|ddr||qt|ddr||q|r@|r4tdddd|D||s=td||}n|rRtd dd d|D||s[td ||}d d|DS) aGets all the release track command implementations from the module. Args: mod_file: str, The __file__ attribute of the module resulting from importing the file containing a command. module_attributes: The __dict__.values() of the module. is_command: bool, True if we are loading a command, False to load a group. Raises: LayoutException: If there is not exactly one type inheriting CommonBase. Returns: [(func->base._Common, [base.ReleaseTrack])], A list of tuples that can be passed to _ExtractReleaseTrackImplementation. Each item in this list represents a command implementation. The first element is a function that returns the implementation, and the second element is a list of release tracks it is valid for. IS_COMMANDFIS_COMMAND_GROUPz7You cannot define groups [{0}] in a command file: [{1}], cSg|]}|jqSrr).0grrr z._ImplementationsFromModule..z"No commands defined in file: [{0}]z?You cannot define commands [{0}] in a command group file: [{1}]cSrrrrcrrrrrz(No command groups defined in file: [{0}]cSs g|] }|fdd|fqS)cSs|SrNr)rrrrsz7_ImplementationsFromModule...)ValidReleaseTracksrrrrrs )getattrr?r rr0)mod_filemodule_attributesrJr7r6command_or_groupcommands_or_groupsrrrrc_s>    rccs6s tdtdfddt|D}|S)aGets all the release track command implementations from the yaml file. Args: path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. data: dict, The loaded yaml data. yaml_command_translator: YamlCommandTranslator, An instance of a translator to use to load the yaml data. Raises: CommandLoadFailure: If the command is invalid and cannot be loaded. Returns: [(func->base._Common, [base.ReleaseTrack])], A list of tuples that can be passed to _ExtractReleaseTrackImplementation. Each item in this list represents a command implementation. The first element is a function that returns the implementation, and the second element is a list of release tracks it is valid for. r+z.No yaml command translator has been registeredcs4g|]}|ffdd dd|dgDfqS)cs |SrN)r')rr%rKrrrs z5_ImplementationsFromYaml...cSsh|]}tj|qSr)r ReleaseTrackFromId)rtrrr sz6_ImplementationsFromYaml...r)r)rrrrrrs z,_ImplementationsFromYaml..)r r0r1r SeparateDeclarativeCommandTracks)r%rirKrLrrrras racst|dkr|d\}}|r|vr|Stdj|t}|D]'\}}|s/td|||@}|rEtdddd|D|||O}q"fd d|D}t|dkrbtdj||dS) aeValidates and extracts the correct implementation of the command or group. Args: impl_file: str, The path to the file this was loaded from (for error reporting). expected_track: base.ReleaseTrack, The release track we are trying to load. implementations: [(func->base._Common, [base.ReleaseTrack])], A list of tuples where each item in this list represents a command implementation. The first element is a function that returns the implementation, and the second element is a list of release tracks it is valid for. Raises: LayoutException: If there is not exactly one type inheriting CommonBase. ReleaseTrackNotImplementedException: If there is no command or group implementation for the request release track. Returns: object, The single implementation that matches the expected release track. r*rz.csg|] \}}|vr|qSrr)rimpl valid_tracksexpected_trackrrrs )r/r#ridrr r0)rhrrLrrimplemented_release_tracks duplicatesvalid_commands_or_groupsrrrrGsB       rGrN),r __future__rrrr(rr=r:googlecloudsdk.callioperrgooglecloudsdk.corergooglecloudsdk.core.utilrruamelr rrorvr1r r r#with_metaclassABCMetaobjectr$r8r3rMrVrZr]rFr^r_rzr[rbrcrarGrrrrsN         $# &  9&&N!@ *