http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/exceptions.py ---------------------------------------------------------------------- diff --git a/aria/utils/exceptions.py b/aria/utils/exceptions.py index 4ecadba..5bb0e6d 100644 --- a/aria/utils/exceptions.py +++ b/aria/utils/exceptions.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities exceptions module +Utilities for extracting and formatting Python exceptions. """ import sys
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/file.py ---------------------------------------------------------------------- diff --git a/aria/utils/file.py b/aria/utils/file.py index 06d3f8e..75f2859 100644 --- a/aria/utils/file.py +++ b/aria/utils/file.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities file module +File utilities. """ import errno @@ -23,7 +23,9 @@ import shutil def makedirs(path): - """An extension of os.makedirs that doesn't fail if the directory already exists""" + """ + Enhancement of :func:`os.makedirs` that doesn't fail if the directory already exists. + """ if os.path.isdir(path): return try: @@ -33,7 +35,6 @@ def makedirs(path): raise def remove_if_exists(path): - try: if os.path.isfile(path): os.remove(path) http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/formatting.py ---------------------------------------------------------------------- diff --git a/aria/utils/formatting.py b/aria/utils/formatting.py index 0ccfa9f..fa34b7d 100644 --- a/aria/utils/formatting.py +++ b/aria/utils/formatting.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities formatting module +String formatting and string-based format utilities. """ import json @@ -103,7 +103,7 @@ def decode_dict(data): def safe_str(value): """ - Like :func:`str` coercion, but makes sure that Unicode strings are properly encoded, and will + Like :class:`str` coercion, but makes sure that Unicode strings are properly encoded, and will never return ``None``. """ http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/http.py ---------------------------------------------------------------------- diff --git a/aria/utils/http.py b/aria/utils/http.py index 580e3e7..c8357e9 100644 --- a/aria/utils/http.py +++ b/aria/utils/http.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities HTTP module +HTTP utilities. """ import os @@ -27,14 +27,14 @@ def download_file(url, destination=None, logger=None, progress_handler=None): """ Download file. - May raise IOError as well as requests.exceptions.RequestException - - :param url: location of the file to download - :type url: str - :param destination: location where the file should be saved (autogenerated by default) - :type destination: str | None - :returns: Location where the file was saved - :rtype: str + :param url: URL from which to download + :type url: basestring + :param destination: path where the file should be saved or ``None`` to auto-generate + :type destination: basestring + :returns: path where the file was saved + :rtype: basestring + :raises exceptions.IOError: + :raises requests.exceptions.RequestException: """ chunk_size = 1024 http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/imports.py ---------------------------------------------------------------------- diff --git a/aria/utils/imports.py b/aria/utils/imports.py index 2c9de53..14ad09e 100644 --- a/aria/utils/imports.py +++ b/aria/utils/imports.py @@ -14,9 +14,7 @@ # limitations under the License. """ -ARIA utilities imports module - -Utility functions for dynamically loading Python code. +Utilities for dynamically loading Python code. """ import pkgutil @@ -52,8 +50,8 @@ def import_fullname(name, paths=None): def import_modules(name): """ - Imports a module and all its sub-modules, recursively. - Relies on modules defining a 'MODULES' attribute listing their sub-module names. + Imports a module and all its sub-modules, recursively. Relies on modules defining a ``MODULES`` + attribute listing their sub-module names. """ module = __import__(name, fromlist=['MODULES'], level=0) @@ -65,9 +63,9 @@ def import_modules(name): # TODO merge with import_fullname def load_attribute(attribute_path): """ - Dynamically load an attribute based on the path to it. - e.g. some_package.some_module.some_attribute, will load the some_attribute from the - some_package.some_module module + Dynamically load an attribute based on the path to it. E.g. + ``some_package.some_module.some_attribute``, will load ``some_attribute`` from the + ``some_package.some_module`` module. """ module_name, attribute_name = attribute_path.rsplit('.', 1) try: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/openclose.py ---------------------------------------------------------------------- diff --git a/aria/utils/openclose.py b/aria/utils/openclose.py index b04a6d4..722885c 100644 --- a/aria/utils/openclose.py +++ b/aria/utils/openclose.py @@ -14,12 +14,12 @@ # limitations under the License. """ -ARIA utilities open-close module +Utilities for working with open/close patterns. """ class OpenClose(object): """ - Wraps an object that has open() and close() methods to support the "with" keyword. + Wraps an object that has ``open()`` and ``close()`` methods to support the ``with`` keyword. """ def __init__(self, wrapped): http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/plugin.py ---------------------------------------------------------------------- diff --git a/aria/utils/plugin.py b/aria/utils/plugin.py index 58078ae..4fb6a8e 100644 --- a/aria/utils/plugin.py +++ b/aria/utils/plugin.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities plugin module +Plugin utilities. """ import wagon http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/process.py ---------------------------------------------------------------------- diff --git a/aria/utils/process.py b/aria/utils/process.py index b0e230c..ec4a72d 100644 --- a/aria/utils/process.py +++ b/aria/utils/process.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities process module +Process utilities. """ import os http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/specification.py ---------------------------------------------------------------------- diff --git a/aria/utils/specification.py b/aria/utils/specification.py index 273897c..8c51134 100644 --- a/aria/utils/specification.py +++ b/aria/utils/specification.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities specification module +Utilities for cross-referencing code with specification documents. """ from .collections import OrderedDict http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/threading.py ---------------------------------------------------------------------- diff --git a/aria/utils/threading.py b/aria/utils/threading.py index d60f28f..b9d627a 100644 --- a/aria/utils/threading.py +++ b/aria/utils/threading.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities threading module +Threading utilities. """ from __future__ import absolute_import # so we can import standard 'threading' @@ -38,16 +38,15 @@ class DaemonThread(Thread): def run(self): """ - We're overriding `Thread.run` in order to avoid annoying (but harmless) error - messages during shutdown. The problem is that CPython nullifies the - global state _before_ shutting down daemon threads, so that exceptions - might happen, and then `Thread.__bootstrap_inner` prints them out. + We're overriding ``Thread.run`` in order to avoid annoying (but harmless) error messages + during shutdown. The problem is that CPython nullifies the global state _before_ shutting + down daemon threads, so that exceptions might happen, and then ``Thread.__bootstrap_inner`` + prints them out. Our solution is to swallow these exceptions here. - The side effect is that uncaught exceptions in our own thread code will _not_ - be printed out as usual, so it's our responsibility to catch them in our - code. + The side effect is that uncaught exceptions in our own thread code will _not_ be printed out + as usual, so it's our responsibility to catch them in our code. """ try: @@ -83,8 +82,8 @@ class FixedThreadPoolExecutor(object): executor.raise_first() print executor.returns - You can also use it with the Python "with" keyword, in which case you don't need to call "close" - explicitly:: + You can also use it with the Python ``with`` keyword, in which case you don't need to call + ``close`` explicitly:: with FixedThreadPoolExecutor(10) as executor: for value in range(100): @@ -101,11 +100,10 @@ class FixedThreadPoolExecutor(object): timeout=None, print_exceptions=False): """ - :param size: Number of threads in the pool (fixed). - :param timeout: Timeout in seconds for all - blocking operations. (Defaults to none, meaning no timeout) - :param print_exceptions: Set to true in order to - print exceptions from tasks. (Defaults to false) + :param size: number of threads in the pool; if ``None`` will use an optimal number for the + platform + :param timeout: timeout in seconds for all blocking operations (``None`` means no timeout) + :param print_exceptions: set to ``True`` in order to print exceptions from tasks """ if not size: try: @@ -151,7 +149,7 @@ class FixedThreadPoolExecutor(object): You cannot submit tasks anymore after calling this. - This is called automatically upon exit if you are using the "with" keyword. + This is called automatically upon exit if you are using the ``with`` keyword. """ self.drain() @@ -200,9 +198,9 @@ class FixedThreadPoolExecutor(object): """ If exceptions were thrown by any task, then the first one will be raised. - This is rather arbitrary: proper handling would involve iterating all the - exceptions. However, if you want to use the "raise" mechanism, you are - limited to raising only one of them. + This is rather arbitrary: proper handling would involve iterating all the exceptions. + However, if you want to use the "raise" mechanism, you are limited to raising only one of + them. """ exceptions = self.exceptions @@ -247,11 +245,10 @@ class FixedThreadPoolExecutor(object): class LockedList(list): """ - A list that supports the "with" keyword with a built-in lock. + A list that supports the ``with`` keyword with a built-in lock. - Though Python lists are thread-safe in that they will not raise exceptions - during concurrent access, they do not guarantee atomicity. This class will - let you gain atomicity when needed. + Though Python lists are thread-safe in that they will not raise exceptions during concurrent + access, they do not guarantee atomicity. This class will let you gain atomicity when needed. """ def __init__(self, *args, **kwargs): @@ -267,7 +264,7 @@ class LockedList(list): class ExceptionThread(Thread): """ - A thread from which top level exceptions can be retrieved or reraised + A thread from which top level exceptions can be retrieved or re-raised. """ def __init__(self, *args, **kwargs): Thread.__init__(self, *args, **kwargs) http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/type.py ---------------------------------------------------------------------- diff --git a/aria/utils/type.py b/aria/utils/type.py index 3c48cf5..fe88a62 100644 --- a/aria/utils/type.py +++ b/aria/utils/type.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities type module +Type utilities. """ import datetime @@ -83,7 +83,7 @@ def full_type_name(value): @implements_specification('3.2.1-1', 'tosca-simple-1.0') def canonical_type_name(value): """ - Returns the canonical TOSCA type name of a primitive value, or None if unknown. + Returns the canonical TOSCA type name of a primitive value, or ``None`` if unknown. For a list of TOSCA type names, see the `TOSCA Simple Profile v1.0 cos01 specification <http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/cos01 @@ -99,7 +99,7 @@ def canonical_type_name(value): @implements_specification('3.2.1-2', 'tosca-simple-1.0') def canonical_type(type_name): """ - Return the canonical type for any Python, YAML, or TOSCA type name or alias, or None if + Return the canonical type for any Python, YAML, or TOSCA type name or alias, or ``None`` if unsupported. :param type_name: Type name (case insensitive) @@ -113,9 +113,8 @@ def validate_value_type(value, type_name): Validate that a value is of a specific type. Supports Python, YAML, and TOSCA type names and aliases. - A ValueError will be raised on type mismatch. - - :param type_name: Type name (case insensitive) + :param type_name: type name (case insensitive) + :raises ~exceptions.ValueError: on type mismatch """ the_type = canonical_type(type_name) @@ -136,9 +135,8 @@ def convert_value_to_type(str_value, python_type_name): """ Converts a value to a specific Python primitive type. - A ValueError will be raised for unsupported types or conversion failure. - :param python_type_name: Python primitive type name (case insensitive) + :raises ~exceptions.ValueError: for unsupported types or conversion failure """ python_type_name = python_type_name.lower() http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/uris.py ---------------------------------------------------------------------- diff --git a/aria/utils/uris.py b/aria/utils/uris.py index c2f276e..49881f2 100644 --- a/aria/utils/uris.py +++ b/aria/utils/uris.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities URIs module +URI utilities. """ import os @@ -27,7 +27,7 @@ _IS_WINDOWS = (os.name == 'nt') def as_file(uri): """ If the URI is a file (either the ``file`` scheme or no scheme), then returns the normalized - path. Otherwise, returns None. + path. Otherwise, returns ``None``. """ if _IS_WINDOWS: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/uuid.py ---------------------------------------------------------------------- diff --git a/aria/utils/uuid.py b/aria/utils/uuid.py index fdec879..d6c9ced 100644 --- a/aria/utils/uuid.py +++ b/aria/utils/uuid.py @@ -14,7 +14,7 @@ # limitations under the License. """ -ARIA utilities UUID module +UUID generation utilities. """ from __future__ import absolute_import # so we can import standard 'uuid' @@ -36,13 +36,14 @@ def generate_uuid(length=None, variant='base57'): """ A random string with varying degrees of guarantee of universal uniqueness. - :param variant: * 'base57' (the default) uses a mix of upper and lowercase alphanumerics - ensuring no visually ambiguous characters; default length 22 - * 'alphanumeric' uses lowercase alphanumeric; default length 25 - * 'uuid' uses lowercase hexadecimal in the classic UUID format, including - dashes; length is always 36 - * 'hex' uses lowercase hexadecimal characters but has no guarantee of - uniqueness; default length of 5 + :param variant: + * ``base57`` (the default) uses a mix of upper and lowercase alphanumerics ensuring no visually + ambiguous characters; default length 22 + * ``alphanumeric`` uses lowercase alphanumeric; default length 25 + * ``uuid`` uses lowercase hexadecimal in the classic UUID format, including dashes; length is + always 36 + * ``hex`` uses lowercase hexadecimal characters but has no guarantee of uniqueness; default + length of 5 """ if variant == 'base57': http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/validation.py ---------------------------------------------------------------------- diff --git a/aria/utils/validation.py b/aria/utils/validation.py index 8b2bb7d..3452dcc 100644 --- a/aria/utils/validation.py +++ b/aria/utils/validation.py @@ -14,9 +14,7 @@ # limitations under the License. """ -ARIA utilities validation module - -Contains validation related utilities +Validation utilities. """ from .formatting import string_list_as_string @@ -24,7 +22,7 @@ from .formatting import string_list_as_string class ValidatorMixin(object): """ - A mixin that should be added to classes that require validating user input + A mix0in that should be added to classes that require validating user input. """ _ARGUMENT_TYPE_MESSAGE = '{name} argument must be {type} based, got {arg!r}' @@ -70,7 +68,7 @@ class ValidatorMixin(object): def validate_function_arguments(func, func_kwargs): """ Validates all required arguments are supplied to ``func`` and that no additional arguments are - supplied + supplied. """ _kwargs_flags = 8 http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/aria/utils/versions.py ---------------------------------------------------------------------- diff --git a/aria/utils/versions.py b/aria/utils/versions.py index 1e64f47..521004c 100644 --- a/aria/utils/versions.py +++ b/aria/utils/versions.py @@ -14,9 +14,7 @@ # limitations under the License. """ -ARIA utilities version module - -General-purpose version string handling +Verion string utilities. """ import re @@ -57,8 +55,9 @@ class VersionString(unicode): Any value that does not conform to this format will be treated as a zero version, which would be lesser than any non-zero version. - For efficient list sorts use the ``key`` property, e.g.: - ``sorted(versions, key=lambda x: x.key)`` + For efficient list sorts use the ``key`` property, e.g.:: + + sorted(versions, key=lambda x: x.key) """ NULL = None # initialized below @@ -86,9 +85,9 @@ def parse_version_string(version): # pylint: disable=too-many-branches """ Parses a version string. - :param version: The version string - :returns: The primary tuple and qualifier float - :rtype: ((int), float) + :param version: version string + :returns: primary tuple and qualifier float + :rtype: ((:obj:`int`), :obj:`float`) """ if version is None: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.cli.rst ---------------------------------------------------------------------- diff --git a/docs/aria.cli.rst b/docs/aria.cli.rst index e1518e8..c325cf0 100644 --- a/docs/aria.cli.rst +++ b/docs/aria.cli.rst @@ -15,86 +15,86 @@ limitations under the License. :mod:`aria.cli` ---------------- +=============== .. automodule:: aria.cli :mod:`aria.cli.color` -##################### +--------------------- .. automodule:: aria.cli.color :mod:`aria.cli.csar` -#################### +-------------------- .. automodule:: aria.cli.csar :mod:`aria.cli.defaults` -######################## +------------------------ .. automodule:: aria.cli.defaults :mod:`aria.cli.exceptions` -########################## +-------------------------- .. automodule:: aria.cli.exceptions :mod:`aria.cli.execution_logging` -################################# +--------------------------------- .. automodule:: aria.cli.execution_logging :mod:`aria.cli.helptexts` -######################### +------------------------- .. automodule:: aria.cli.helptexts :mod:`aria.cli.inputs` -###################### +---------------------- .. automodule:: aria.cli.inputs :mod:`aria.cli.logger` -###################### +---------------------- .. automodule:: aria.cli.logger :mod:`aria.cli.main` -#################### +-------------------- .. automodule:: aria.cli.main :mod:`aria.cli.service_template_utils` -###################################### +-------------------------------------- .. automodule:: aria.cli.service_template_utils :mod:`aria.cli.table` -##################### +--------------------- .. automodule:: aria.cli.table :mod:`aria.cli.utils` -##################### +--------------------- .. automodule:: aria.cli.utils :mod:`aria.cli.config` -###################### +---------------------- .. automodule:: aria.cli.config :mod:`aria.cli.config.config` -############################# +----------------------------- .. automodule:: aria.cli.config.config :mod:`aria.cli.core` -#################### +-------------------- .. automodule:: aria.cli.core :mod:`aria.cli.core.aria` -######################### +------------------------- .. automodule:: aria.cli.core.aria http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.modeling.models.rst ---------------------------------------------------------------------- diff --git a/docs/aria.modeling.models.rst b/docs/aria.modeling.models.rst index b1ddb29..6431780 100644 --- a/docs/aria.modeling.models.rst +++ b/docs/aria.modeling.models.rst @@ -14,9 +14,8 @@ See the License for the specific language governing permissions and limitations under the License. - :mod:`aria.modeling.models` ---------------------------- +=========================== .. automodule:: aria.modeling.models :no-show-inheritance: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.modeling.rst ---------------------------------------------------------------------- diff --git a/docs/aria.modeling.rst b/docs/aria.modeling.rst index d7fd138..b85e22c 100644 --- a/docs/aria.modeling.rst +++ b/docs/aria.modeling.rst @@ -16,41 +16,41 @@ :mod:`aria.modeling` --------------------- +==================== .. automodule:: aria.modeling :mod:`aria.modeling.constraints` -################################ +-------------------------------- .. automodule:: aria.modeling.constraints :mod:`aria.modeling.exceptions` -############################### +------------------------------- .. automodule:: aria.modeling.exceptions :mod:`aria.modeling.functions` -############################## +------------------------------ .. automodule:: aria.modeling.functions :mod:`aria.modeling.mixins` -########################### +--------------------------- .. automodule:: aria.modeling.mixins :mod:`aria.modeling.relationship` -################################# +--------------------------------- .. automodule:: aria.modeling.relationship :mod:`aria.modeling.types` -########################## +-------------------------- .. automodule:: aria.modeling.types :mod:`aria.modeling.utils` -########################## +-------------------------- .. automodule:: aria.modeling.utils http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.orchestrator.context.rst ---------------------------------------------------------------------- diff --git a/docs/aria.orchestrator.context.rst b/docs/aria.orchestrator.context.rst new file mode 100644 index 0000000..395befc --- /dev/null +++ b/docs/aria.orchestrator.context.rst @@ -0,0 +1,46 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +:mod:`aria.orchestrator.context` +================================ + +.. automodule:: aria.orchestrator.context + +:mod:`aria.orchestrator.context.common` +--------------------------------------- + +.. automodule:: aria.orchestrator.context.common + +:mod:`aria.orchestrator.context.exceptions` +------------------------------------------- + +.. automodule:: aria.orchestrator.context.exceptions + +:mod:`aria.orchestrator.context.operation` +------------------------------------------ + +.. automodule:: aria.orchestrator.context.operation + +:mod:`aria.orchestrator.context.toolbelt` +----------------------------------------- + +.. automodule:: aria.orchestrator.context.toolbelt + +:mod:`aria.orchestrator.context.workflow` +----------------------------------------- + +.. automodule:: aria.orchestrator.context.workflow http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.orchestrator.execution_plugin.ctx_proxy.rst ---------------------------------------------------------------------- diff --git a/docs/aria.orchestrator.execution_plugin.ctx_proxy.rst b/docs/aria.orchestrator.execution_plugin.ctx_proxy.rst new file mode 100644 index 0000000..47ed598 --- /dev/null +++ b/docs/aria.orchestrator.execution_plugin.ctx_proxy.rst @@ -0,0 +1,31 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +:mod:`aria.orchestrator.execution_plugin.ctx_proxy` +=================================================== + +.. automodule:: aria.orchestrator.execution_plugin.ctx_proxy + +:mod:`aria.orchestrator.execution_plugin.ctx_proxy.client` +---------------------------------------------------------- + +.. automodule:: aria.orchestrator.execution_plugin.ctx_proxy.client + +:mod:`aria.orchestrator.execution_plugin.ctx_proxy.server` +---------------------------------------------------------- + +.. automodule:: aria.orchestrator.execution_plugin.ctx_proxy.server http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.orchestrator.execution_plugin.rst ---------------------------------------------------------------------- diff --git a/docs/aria.orchestrator.execution_plugin.rst b/docs/aria.orchestrator.execution_plugin.rst index 8abd0cc..177a316 100644 --- a/docs/aria.orchestrator.execution_plugin.rst +++ b/docs/aria.orchestrator.execution_plugin.rst @@ -16,16 +16,41 @@ :mod:`aria.orchestrator.execution_plugin` ------------------------------------------ +========================================= .. automodule:: aria.orchestrator.execution_plugin -:mod:`aria.orchestrator.execution_plugin.ctx_proxy` -################################################### +:mod:`aria.orchestrator.execution_plugin.common` +------------------------------------------------ -.. automodule:: aria.orchestrator.execution_plugin.ctx_proxy +.. automodule:: aria.orchestrator.execution_plugin.common -:mod:`aria.orchestrator.execution_plugin.ssh` -############################################# +:mod:`aria.orchestrator.execution_plugin.constants` +--------------------------------------------------- -.. automodule:: aria.orchestrator.execution_plugin.ssh +.. automodule:: aria.orchestrator.execution_plugin.constants + +:mod:`aria.orchestrator.execution_plugin.environment_globals` +------------------------------------------------------------- + +.. automodule:: aria.orchestrator.execution_plugin.environment_globals + +:mod:`aria.orchestrator.execution_plugin.exceptions` +---------------------------------------------------- + +.. automodule:: aria.orchestrator.execution_plugin.exceptions + +:mod:`aria.orchestrator.execution_plugin.instantiation` +------------------------------------------------------- + +.. automodule:: aria.orchestrator.execution_plugin.instantiation + +:mod:`aria.orchestrator.execution_plugin.local` +----------------------------------------------- + +.. automodule:: aria.orchestrator.execution_plugin.local + +:mod:`aria.orchestrator.execution_plugin.operations` +---------------------------------------------------- + +.. automodule:: aria.orchestrator.execution_plugin.operations http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.orchestrator.execution_plugin.ssh.rst ---------------------------------------------------------------------- diff --git a/docs/aria.orchestrator.execution_plugin.ssh.rst b/docs/aria.orchestrator.execution_plugin.ssh.rst new file mode 100644 index 0000000..8bbaa57 --- /dev/null +++ b/docs/aria.orchestrator.execution_plugin.ssh.rst @@ -0,0 +1,31 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +:mod:`aria.orchestrator.execution_plugin.ssh` +============================================= + +.. automodule:: aria.orchestrator.execution_plugin.ssh + +:mod:`aria.orchestrator.execution_plugin.ssh.operations` +-------------------------------------------------------- + +.. automodule:: aria.orchestrator.execution_plugin.ssh.operations + +:mod:`aria.orchestrator.execution_plugin.ssh.tunnel` +---------------------------------------------------- + +.. automodule:: aria.orchestrator.execution_plugin.ssh.tunnel http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.orchestrator.rst ---------------------------------------------------------------------- diff --git a/docs/aria.orchestrator.rst b/docs/aria.orchestrator.rst index 962367f..33454e6 100644 --- a/docs/aria.orchestrator.rst +++ b/docs/aria.orchestrator.rst @@ -16,11 +16,31 @@ :mod:`aria.orchestrator` ------------------------- +======================== .. automodule:: aria.orchestrator -:mod:`aria.orchestrator.context` -################################ +:mod:`aria.orchestrator.decorators` +----------------------------------- -.. automodule:: aria.orchestrator.context +.. automodule:: aria.orchestrator.decorators + +:mod:`aria.orchestrator.events` +------------------------------- + +.. automodule:: aria.orchestrator.events + +:mod:`aria.orchestrator.exceptions` +----------------------------------- + +.. automodule:: aria.orchestrator.exceptions + +:mod:`aria.orchestrator.plugin` +------------------------------- + +.. automodule:: aria.orchestrator.plugin + +:mod:`aria.orchestrator.workflow_runner` +---------------------------------------- + +.. automodule:: aria.orchestrator.workflow_runner http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.orchestrator.workflows.api.rst ---------------------------------------------------------------------- diff --git a/docs/aria.orchestrator.workflows.api.rst b/docs/aria.orchestrator.workflows.api.rst new file mode 100644 index 0000000..7ecac75 --- /dev/null +++ b/docs/aria.orchestrator.workflows.api.rst @@ -0,0 +1,31 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +:mod:`aria.orchestrator.workflows.api` +====================================== + +.. automodule:: aria.orchestrator.workflows.api + +:mod:`aria.orchestrator.workflows.api.task_graph` +------------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.api.task_graph + +:mod:`aria.orchestrator.workflows.api.task` +------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.api.task http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.orchestrator.workflows.builtin.rst ---------------------------------------------------------------------- diff --git a/docs/aria.orchestrator.workflows.builtin.rst b/docs/aria.orchestrator.workflows.builtin.rst new file mode 100644 index 0000000..de1a8f9 --- /dev/null +++ b/docs/aria.orchestrator.workflows.builtin.rst @@ -0,0 +1,57 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + + +:mod:`aria.orchestrator.workflows.builtin` +========================================== + +.. automodule:: aria.orchestrator.workflows.builtin + +:mod:`aria.orchestrator.workflows.builtin.execute_operation` +------------------------------------------------------------ + +.. automodule:: aria.orchestrator.workflows.builtin.execute_operation + +:mod:`aria.orchestrator.workflows.builtin.heal` +----------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.builtin.heal + +:mod:`aria.orchestrator.workflows.builtin.install` +-------------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.builtin.install + +:mod:`aria.orchestrator.workflows.builtin.start` +------------------------------------------------ + +.. automodule:: aria.orchestrator.workflows.builtin.start + +:mod:`aria.orchestrator.workflows.builtin.stop` +----------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.builtin.stop + +:mod:`aria.orchestrator.workflows.builtin.uninstall` +---------------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.builtin.uninstall + +:mod:`aria.orchestrator.workflows.builtin.workflows` +---------------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.builtin.workflows http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.orchestrator.workflows.executor.rst ---------------------------------------------------------------------- diff --git a/docs/aria.orchestrator.workflows.executor.rst b/docs/aria.orchestrator.workflows.executor.rst new file mode 100644 index 0000000..cde0a77 --- /dev/null +++ b/docs/aria.orchestrator.workflows.executor.rst @@ -0,0 +1,46 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +:mod:`aria.orchestrator.workflows.executor` +=========================================== + +.. automodule:: aria.orchestrator.workflows.executor + +:mod:`aria.orchestrator.workflows.executor.base` +------------------------------------------------ + +.. automodule:: aria.orchestrator.workflows.executor.base + +:mod:`aria.orchestrator.workflows.executor.celery` +-------------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.executor.celery + +:mod:`aria.orchestrator.workflows.executor.dry` +----------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.executor.dry + +:mod:`aria.orchestrator.workflows.executor.process` +--------------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.executor.process + +:mod:`aria.orchestrator.workflows.executor.thread` +-------------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.executor.thread http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.orchestrator.workflows.rst ---------------------------------------------------------------------- diff --git a/docs/aria.orchestrator.workflows.rst b/docs/aria.orchestrator.workflows.rst index 4e0e50b..12f8d9d 100644 --- a/docs/aria.orchestrator.workflows.rst +++ b/docs/aria.orchestrator.workflows.rst @@ -16,26 +16,36 @@ :mod:`aria.orchestrator.workflows` ----------------------------------- +================================== .. automodule:: aria.orchestrator.workflows -:mod:`aria.orchestrator.workflows.api` -###################################### +:mod:`aria.orchestrator.workflows.events_logging` +------------------------------------------------- -.. automodule:: aria.orchestrator.workflows.api +.. automodule:: aria.orchestrator.workflows.events_logging -:mod:`aria.orchestrator.workflows.builtin` -########################################## +:mod:`aria.orchestrator.workflows.exceptions` +--------------------------------------------- -.. automodule:: aria.orchestrator.workflows.builtin +.. automodule:: aria.orchestrator.workflows.exceptions :mod:`aria.orchestrator.workflows.core` -####################################### +--------------------------------------- .. automodule:: aria.orchestrator.workflows.core -:mod:`aria.orchestrator.workflows.executor` -########################################### +:mod:`aria.orchestrator.workflows.core.compile` +----------------------------------------------- -.. automodule:: aria.orchestrator.workflows.executor +.. automodule:: aria.orchestrator.workflows.core.compile + +:mod:`aria.orchestrator.workflows.core.engine` +---------------------------------------------- + +.. automodule:: aria.orchestrator.workflows.core.engine + +:mod:`aria.orchestrator.workflows.core.events_handler` +------------------------------------------------------ + +.. automodule:: aria.orchestrator.workflows.core.events_handler http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.parser.consumption.rst ---------------------------------------------------------------------- diff --git a/docs/aria.parser.consumption.rst b/docs/aria.parser.consumption.rst index d991ad9..3d9fc6e 100644 --- a/docs/aria.parser.consumption.rst +++ b/docs/aria.parser.consumption.rst @@ -16,46 +16,6 @@ :mod:`aria.parser.consumption` ------------------------------- +============================== .. automodule:: aria.parser.consumption - -:mod:`aria.parser.consumption.consumer` -####################################### - -.. automodule:: aria.parser.consumption.consumer - -:mod:`aria.parser.consumption.context` -###################################### - -.. automodule:: aria.parser.consumption.context - -:mod:`aria.parser.consumption.exceptions` -######################################### - -.. automodule:: aria.parser.consumption.exceptions - -:mod:`aria.parser.consumption.inputs` -##################################### - -.. automodule:: aria.parser.consumption.inputs - -:mod:`aria.parser.consumption.modeling` -####################################### - -.. automodule:: aria.parser.consumption.modeling - -:mod:`aria.parser.consumption.presentation` -########################################### - -.. automodule:: aria.parser.consumption.presentation - -:mod:`aria.parser.consumption.style` -#################################### - -.. automodule:: aria.parser.consumption.style - -:mod:`aria.parser.consumption.validation` -######################################### - -.. automodule:: aria.parser.consumption.validation http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.parser.loading.rst ---------------------------------------------------------------------- diff --git a/docs/aria.parser.loading.rst b/docs/aria.parser.loading.rst index de57422..0ae7565 100644 --- a/docs/aria.parser.loading.rst +++ b/docs/aria.parser.loading.rst @@ -16,51 +16,6 @@ :mod:`aria.parser.loading` --------------------------- +========================== .. automodule:: aria.parser.loading - -:mod:`aria.parser.loading.context` -################################## - -.. automodule:: aria.parser.loading.context - -:mod:`aria.parser.loading.exceptions` -##################################### - -.. automodule:: aria.parser.loading.exceptions - -:mod:`aria.parser.loading.file` -############################### - -.. automodule:: aria.parser.loading.file - -:mod:`aria.parser.loading.literal` -################################## - -.. automodule:: aria.parser.loading.literal - -:mod:`aria.parser.loading.loader` -################################# - -.. automodule:: aria.parser.loading.loader - -:mod:`aria.parser.loading.location` -################################### - -.. automodule:: aria.parser.loading.location - -:mod:`aria.parser.loading.request` -################################## - -.. automodule:: aria.parser.loading.request - -:mod:`aria.parser.loading.source` -################################# - -.. automodule:: aria.parser.loading.source - -:mod:`aria.parser.loading.uri` -############################## - -.. automodule:: aria.parser.loading.uri http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.parser.modeling.rst ---------------------------------------------------------------------- diff --git a/docs/aria.parser.modeling.rst b/docs/aria.parser.modeling.rst index 62225b6..16c359c 100644 --- a/docs/aria.parser.modeling.rst +++ b/docs/aria.parser.modeling.rst @@ -16,11 +16,6 @@ :mod:`aria.parser.modeling` ---------------------------- +=========================== .. automodule:: aria.parser.modeling - -:mod:`aria.parser.modeling.context` -################################### - -.. automodule:: aria.parser.modeling.context http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.parser.presentation.rst ---------------------------------------------------------------------- diff --git a/docs/aria.parser.presentation.rst b/docs/aria.parser.presentation.rst index 75660e4..6c63b2e 100644 --- a/docs/aria.parser.presentation.rst +++ b/docs/aria.parser.presentation.rst @@ -16,51 +16,6 @@ :mod:`aria.parser.presentation` -------------------------------- +=============================== .. automodule:: aria.parser.presentation - -:mod:`aria.parser.presentation.context` -####################################### - -.. automodule:: aria.parser.presentation.context - -:mod:`aria.parser.presentation.exceptions` -########################################## - -.. automodule:: aria.parser.presentation.exceptions - -:mod:`aria.parser.presentation.field_validators` -################################################ - -.. automodule:: aria.parser.presentation.field_validators - -:mod:`aria.parser.presentation.fields` -###################################### - -.. automodule:: aria.parser.presentation.fields - -:mod:`aria.parser.presentation.null` -#################################### - -.. automodule:: aria.parser.presentation.null - -:mod:`aria.parser.presentation.presentation` -############################################ - -.. automodule:: aria.parser.presentation.presentation - -:mod:`aria.parser.presentation.presenter` -######################################### - -.. automodule:: aria.parser.presentation.presenter - -:mod:`aria.parser.presentation.source` -###################################### - -.. automodule:: aria.parser.presentation.source - -:mod:`aria.parser.presentation.utils` -##################################### - -.. automodule:: aria.parser.presentation.utils http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.parser.reading.rst ---------------------------------------------------------------------- diff --git a/docs/aria.parser.reading.rst b/docs/aria.parser.reading.rst index ef32a3d..b1d4f6c 100644 --- a/docs/aria.parser.reading.rst +++ b/docs/aria.parser.reading.rst @@ -16,51 +16,6 @@ :mod:`aria.parser.reading` --------------------------- +========================== .. automodule:: aria.parser.reading - -:mod:`aria.parser.reading.context` -################################## - -.. automodule:: aria.parser.reading.context - -:mod:`aria.parser.reading.exceptions` -##################################### - -.. automodule:: aria.parser.reading.exceptions - -:mod:`aria.parser.reading.jinja` -################################ - -.. automodule:: aria.parser.reading.jinja - -:mod:`aria.parser.reading.json` -############################### - -.. automodule:: aria.parser.reading.json - -:mod:`aria.parser.reading.locator` -################################## - -.. automodule:: aria.parser.reading.locator - -:mod:`aria.parser.reading.raw` -############################## - -.. automodule:: aria.parser.reading.raw - -:mod:`aria.parser.reading.reader` -################################# - -.. automodule:: aria.parser.reading.reader - -:mod:`aria.parser.reading.source` -################################# - -.. automodule:: aria.parser.reading.source - -:mod:`aria.parser.reading.yaml` -############################### - -.. automodule:: aria.parser.reading.yaml http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.parser.rst ---------------------------------------------------------------------- diff --git a/docs/aria.parser.rst b/docs/aria.parser.rst index f3765d4..700f03d 100644 --- a/docs/aria.parser.rst +++ b/docs/aria.parser.rst @@ -16,16 +16,16 @@ :mod:`aria.parser` ------------------- +================== .. automodule:: aria.parser :mod:`aria.parser.exceptions` -############################# +----------------------------- .. automodule:: aria.parser.exceptions :mod:`aria.parser.specification` -################################ +-------------------------------- .. automodule:: aria.parser.specification http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.parser.validation.rst ---------------------------------------------------------------------- diff --git a/docs/aria.parser.validation.rst b/docs/aria.parser.validation.rst index 3700b56..621898b 100644 --- a/docs/aria.parser.validation.rst +++ b/docs/aria.parser.validation.rst @@ -16,16 +16,6 @@ :mod:`aria.parser.validation` ------------------------------ +============================= .. automodule:: aria.parser.validation - -:mod:`aria.parser.validation.context` -##################################### - -.. automodule:: aria.parser.validation.context - -:mod:`aria.parser.validation.issue` -################################### - -.. automodule:: aria.parser.validation.issue http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.rst ---------------------------------------------------------------------- diff --git a/docs/aria.rst b/docs/aria.rst index 0af98ef..1a0dae5 100644 --- a/docs/aria.rst +++ b/docs/aria.rst @@ -15,26 +15,26 @@ limitations under the License. :mod:`aria` ------------ +=========== .. automodule:: aria :mod:`aria.core` -################ +---------------- .. automodule:: aria.core :mod:`aria.exceptions` -###################### +---------------------- .. automodule:: aria.exceptions :mod:`aria.extension` -##################### +--------------------- .. automodule:: aria.extension :mod:`aria.logger` -################## +------------------ .. automodule:: aria.logger http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.storage.rst ---------------------------------------------------------------------- diff --git a/docs/aria.storage.rst b/docs/aria.storage.rst index 8eda2f8..7c51c2f 100644 --- a/docs/aria.storage.rst +++ b/docs/aria.storage.rst @@ -16,36 +16,36 @@ :mod:`aria.storage` -------------------- +=================== .. automodule:: aria.storage :mod:`aria.storage.api` -####################### +----------------------- .. automodule:: aria.storage.api :mod:`aria.storage.collection_instrumentation` -############################################## +---------------------------------------------- .. automodule:: aria.storage.collection_instrumentation :mod:`aria.storage.core` -######################## +------------------------ .. automodule:: aria.storage.core :mod:`aria.storage.exceptions` -############################## +------------------------------ .. automodule:: aria.storage.exceptions :mod:`aria.storage.filesystem_rapi` -################################### +----------------------------------- .. automodule:: aria.storage.filesystem_rapi :mod:`aria.storage.sql_mapi` -############################ +---------------------------- .. automodule:: aria.storage.sql_mapi http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria.utils.rst ---------------------------------------------------------------------- diff --git a/docs/aria.utils.rst b/docs/aria.utils.rst index 7f67d23..220c0cd 100644 --- a/docs/aria.utils.rst +++ b/docs/aria.utils.rst @@ -16,106 +16,106 @@ :mod:`aria.utils` ------------------ +================= .. automodule:: aria.utils :mod:`aria.utils.archive` -######################### +------------------------- .. automodule:: aria.utils.archive :mod:`aria.utils.argparse` -########################## +-------------------------- .. automodule:: aria.utils.argparse :mod:`aria.utils.caching` -######################### +------------------------- .. automodule:: aria.utils.caching :mod:`aria.utils.collections` -############################# +----------------------------- .. automodule:: aria.utils.collections :mod:`aria.utils.console` -######################### +------------------------- .. automodule:: aria.utils.console :mod:`aria.utils.exceptions` -############################ +---------------------------- .. automodule:: aria.utils.exceptions :mod:`aria.utils.file` -###################### +---------------------- .. automodule:: aria.utils.file :mod:`aria.utils.formatting` -############################ +---------------------------- .. automodule:: aria.utils.formatting :mod:`aria.utils.http` -###################### +---------------------- .. automodule:: aria.utils.http :mod:`aria.utils.imports` -######################### +------------------------- .. automodule:: aria.utils.imports :mod:`aria.utils.openclose` -########################### +--------------------------- .. automodule:: aria.utils.openclose :mod:`aria.utils.plugin` -######################## +------------------------ .. automodule:: aria.utils.plugin :mod:`aria.utils.process` -######################### +------------------------- .. automodule:: aria.utils.process :mod:`aria.utils.specification` -############################### +------------------------------- .. automodule:: aria.utils.specification :mod:`aria.utils.threading` -########################### +--------------------------- .. automodule:: aria.utils.threading :mod:`aria.utils.type` -###################### +---------------------- .. automodule:: aria.utils.type :mod:`aria.utils.uris` -###################### +---------------------- .. automodule:: aria.utils.uris :mod:`aria.utils.uuid` -###################### +---------------------- .. automodule:: aria.utils.uuid :mod:`aria.utils.validation` -############################ +---------------------------- .. automodule:: aria.utils.validation :mod:`aria.utils.versions` -########################## +-------------------------- .. automodule:: aria.utils.versions http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria_extension_tosca.rst ---------------------------------------------------------------------- diff --git a/docs/aria_extension_tosca.rst b/docs/aria_extension_tosca.rst deleted file mode 100644 index e984e82..0000000 --- a/docs/aria_extension_tosca.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -:mod:`aria_extension_tosca` ---------------------------- - -.. automodule:: aria_extension_tosca - -:mod:`aria_extension_tosca.simple_v1_0` -####################################### - -.. automodule:: aria_extension_tosca.simple_v1_0 - -:mod:`aria_extension_tosca.simple_nfv_v1_0` -########################################### - -.. automodule:: aria_extension_tosca.simple_nfv_v1_0 http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria_extension_tosca.simple_nfv_v1_0.rst ---------------------------------------------------------------------- diff --git a/docs/aria_extension_tosca.simple_nfv_v1_0.rst b/docs/aria_extension_tosca.simple_nfv_v1_0.rst new file mode 100644 index 0000000..6e7b6cd --- /dev/null +++ b/docs/aria_extension_tosca.simple_nfv_v1_0.rst @@ -0,0 +1,20 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +:mod:`aria_extension_tosca.simple_nfv_v1_0` +=========================================== + +.. automodule:: aria_extension_tosca.simple_nfv_v1_0 http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria_extension_tosca.simple_v1_0.modeling.rst ---------------------------------------------------------------------- diff --git a/docs/aria_extension_tosca.simple_v1_0.modeling.rst b/docs/aria_extension_tosca.simple_v1_0.modeling.rst new file mode 100644 index 0000000..8bc5499 --- /dev/null +++ b/docs/aria_extension_tosca.simple_v1_0.modeling.rst @@ -0,0 +1,75 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +:mod:`aria_extension_tosca.simple_v1_0.modeling` +================================================ + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling + +:mod:`aria_extension_tosca.simple_v1_0.modeling.artifacts` +---------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.artifacts + +:mod:`aria_extension_tosca.simple_v1_0.modeling.capabilities` +------------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.capabilities + +:mod:`aria_extension_tosca.simple_v1_0.modeling.constraints` +------------------------------------------------------------ + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.constraints + +:mod:`aria_extension_tosca.simple_v1_0.modeling.copy` +----------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.copy + +:mod:`aria_extension_tosca.simple_v1_0.modeling.data_types` +----------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.data_types + +:mod:`aria_extension_tosca.simple_v1_0.modeling.functions` +---------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.functions + +:mod:`aria_extension_tosca.simple_v1_0.modeling.interfaces` +----------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.interfaces + +:mod:`aria_extension_tosca.simple_v1_0.modeling.parameters` +----------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.parameters + +:mod:`aria_extension_tosca.simple_v1_0.modeling.policies` +--------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.policies + +:mod:`aria_extension_tosca.simple_v1_0.modeling.requirements` +------------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.requirements + +:mod:`aria_extension_tosca.simple_v1_0.modeling.substitution_mappings` +---------------------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.modeling.substitution_mappings http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria_extension_tosca.simple_v1_0.presentation.rst ---------------------------------------------------------------------- diff --git a/docs/aria_extension_tosca.simple_v1_0.presentation.rst b/docs/aria_extension_tosca.simple_v1_0.presentation.rst new file mode 100644 index 0000000..964c029 --- /dev/null +++ b/docs/aria_extension_tosca.simple_v1_0.presentation.rst @@ -0,0 +1,40 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +:mod:`aria_extension_tosca.simple_v1_0.presentation` +==================================================== + +.. automodule:: aria_extension_tosca.simple_v1_0.presentation + +:mod:`aria_extension_tosca.simple_v1_0.presentation.extensible` +--------------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.presentation.extensible + +:mod:`aria_extension_tosca.simple_v1_0.presentation.field_getters` +------------------------------------------------------------------ + +.. automodule:: aria_extension_tosca.simple_v1_0.presentation.field_getters + +:mod:`aria_extension_tosca.simple_v1_0.presentation.field_validators` +--------------------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.presentation.field_validators + +:mod:`aria_extension_tosca.simple_v1_0.presentation.types` +---------------------------------------------------------- + +.. automodule:: aria_extension_tosca.simple_v1_0.presentation.types http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/aria_extension_tosca.simple_v1_0.rst ---------------------------------------------------------------------- diff --git a/docs/aria_extension_tosca.simple_v1_0.rst b/docs/aria_extension_tosca.simple_v1_0.rst new file mode 100644 index 0000000..bdae6ab --- /dev/null +++ b/docs/aria_extension_tosca.simple_v1_0.rst @@ -0,0 +1,20 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +:mod:`aria_extension_tosca.simple_v1_0` +======================================= + +.. automodule:: aria_extension_tosca.simple_v1_0 http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/conf.py ---------------------------------------------------------------------- diff --git a/docs/conf.py b/docs/conf.py index b1a17ea..6361621 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,6 +50,7 @@ with open('../VERSION') as f: # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', 'sphinx_click.ext' ] @@ -318,7 +319,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'aria', u'ARIA', + (master_doc, 'aria', u'ARIA TOSCA', [author], 1) ] @@ -374,41 +375,42 @@ autodoc_default_flags = [ 'show-inheritance' ] -_SKIP_MEMBERS = ( +SKIP_MEMBERS = ( 'FIELDS', 'ALLOW_UNKNOWN_FIELDS', - 'SHORT_FORM_FIELD' + 'SHORT_FORM_FIELD', + 'INSTRUMENTATION_FIELDS' ) -_SKIP_MEMBER_SUFFIXES = ( - '_fk' +SKIP_MEMBER_SUFFIXES = ( + '_fk', ) -_NEVER_SKIP_MEMBERS = ( +NEVER_SKIP_MEMBERS = ( '__evaluate__', ) -# Event handling -def on_skip_members(app, what, name, obj, skip, options): - if name in _NEVER_SKIP_MEMBERS: +# 'autodoc-skip-member' event +def on_skip_member(app, what, name, obj, skip, options): + if name in NEVER_SKIP_MEMBERS: return False - if name in _SKIP_MEMBERS: + if name in SKIP_MEMBERS: return True - for suffix in _SKIP_MEMBER_SUFFIXES: + for suffix in SKIP_MEMBER_SUFFIXES: if name.endswith(suffix): return True return skip from sphinx.domains.python import PythonDomain -class _PatchedPythonDomain(PythonDomain): +class PatchedPythonDomain(PythonDomain): # See: https://github.com/sphinx-doc/sphinx/issues/3866 def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): if 'refspecific' in node: del node['refspecific'] - return super(_PatchedPythonDomain, self).resolve_xref( + return super(PatchedPythonDomain, self).resolve_xref( env, fromdocname, builder, typ, target, node, contnode) def setup(app): - app.connect('autodoc-skip-member', on_skip_members) - app.override_domain(_PatchedPythonDomain) + app.connect('autodoc-skip-member', on_skip_member) + app.override_domain(PatchedPythonDomain) http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/index.rst ---------------------------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 495a350..f68769b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,6 +30,7 @@ Interfaces :includehidden: cli + rest SDK --- @@ -46,8 +47,14 @@ Core aria.modeling aria.modeling.models aria.orchestrator + aria.orchestrator.context aria.orchestrator.execution_plugin + aria.orchestrator.execution_plugin.ctx_proxy + aria.orchestrator.execution_plugin.ssh aria.orchestrator.workflows + aria.orchestrator.workflows.api + aria.orchestrator.workflows.builtin + aria.orchestrator.workflows.executor aria.parser aria.parser.consumption aria.parser.loading @@ -65,7 +72,10 @@ Extensions :maxdepth: 1 :includehidden: - aria_extension_tosca + aria_extension_tosca.simple_v1_0 + aria_extension_tosca.simple_v1_0.modeling + aria_extension_tosca.simple_v1_0.presentation + aria_extension_tosca.simple_nfv_v1_0 Indices and Tables http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/docs/rest.rst ---------------------------------------------------------------------- diff --git a/docs/rest.rst b/docs/rest.rst new file mode 100644 index 0000000..185837e --- /dev/null +++ b/docs/rest.rst @@ -0,0 +1,20 @@ +.. + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +REST +==== + +TODO http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py ---------------------------------------------------------------------- diff --git a/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py b/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py index 849fbd7..64178aa 100644 --- a/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py +++ b/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py @@ -24,9 +24,9 @@ class ToscaSimpleNfvPresenter1_0(ToscaSimplePresenter1_0): # pylint: disable=inv ARIA presenter for the `TOSCA Simple Profile for NFV v1.0 csd04 <http://docs.oasis-open.org /tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html>`__. - Supported :code:`tosca_definitions_version` values: + Supported ``tosca_definitions_version`` values: - * :code:`tosca_simple_profile_for_nfv_1_0` + * ``tosca_simple_profile_for_nfv_1_0`` """ DSL_VERSIONS = ('tosca_simple_profile_for_nfv_1_0',) http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/extensions/aria_extension_tosca/simple_v1_0/__init__.py ---------------------------------------------------------------------- diff --git a/extensions/aria_extension_tosca/simple_v1_0/__init__.py b/extensions/aria_extension_tosca/simple_v1_0/__init__.py index 7dcc60a..61995db 100644 --- a/extensions/aria_extension_tosca/simple_v1_0/__init__.py +++ b/extensions/aria_extension_tosca/simple_v1_0/__init__.py @@ -13,6 +13,115 @@ # See the License for the specific language governing permissions and # limitations under the License. +""" +Parser implementation of `TOSCA Simple Profile v1.0 cos01 <http://docs.oasis-open.org/tosca +/TOSCA-Simple-Profile-YAML/v1.0/cos01/TOSCA-Simple-Profile-YAML-v1.0-cos01.html>`__. + +.. autosummary:: + :nosignatures: + + aria_extension_tosca.simple_v1_0.ToscaSimplePresenter1_0 + +Assignments +----------- + +.. autosummary:: + :nosignatures: + + aria_extension_tosca.simple_v1_0.PropertyAssignment + aria_extension_tosca.simple_v1_0.OperationAssignment + aria_extension_tosca.simple_v1_0.InterfaceAssignment + aria_extension_tosca.simple_v1_0.RelationshipAssignment + aria_extension_tosca.simple_v1_0.RequirementAssignment + aria_extension_tosca.simple_v1_0.AttributeAssignment + aria_extension_tosca.simple_v1_0.CapabilityAssignment + aria_extension_tosca.simple_v1_0.ArtifactAssignment + +Definitions +----------- + +.. autosummary:: + :nosignatures: + + aria_extension_tosca.simple_v1_0.PropertyDefinition + aria_extension_tosca.simple_v1_0.AttributeDefinition + aria_extension_tosca.simple_v1_0.ParameterDefinition + aria_extension_tosca.simple_v1_0.OperationDefinition + aria_extension_tosca.simple_v1_0.InterfaceDefinition + aria_extension_tosca.simple_v1_0.RelationshipDefinition + aria_extension_tosca.simple_v1_0.RequirementDefinition + aria_extension_tosca.simple_v1_0.CapabilityDefinition + +Filters +------- + +.. autosummary:: + :nosignatures: + + aria_extension_tosca.simple_v1_0.CapabilityFilter + aria_extension_tosca.simple_v1_0.NodeFilter + +Miscellaneous +------------- + +.. autosummary:: + :nosignatures: + + aria_extension_tosca.simple_v1_0.Description + aria_extension_tosca.simple_v1_0.MetaData + aria_extension_tosca.simple_v1_0.Repository + aria_extension_tosca.simple_v1_0.Import + aria_extension_tosca.simple_v1_0.ConstraintClause + aria_extension_tosca.simple_v1_0.EntrySchema + aria_extension_tosca.simple_v1_0.OperationImplementation + aria_extension_tosca.simple_v1_0.SubstitutionMappingsRequirement + aria_extension_tosca.simple_v1_0.SubstitutionMappingsCapability + aria_extension_tosca.simple_v1_0.SubstitutionMappings + +Templates +--------- + +.. autosummary:: + :nosignatures: + + aria_extension_tosca.simple_v1_0.NodeTemplate + aria_extension_tosca.simple_v1_0.RelationshipTemplate + aria_extension_tosca.simple_v1_0.GroupTemplate + aria_extension_tosca.simple_v1_0.PolicyTemplate + aria_extension_tosca.simple_v1_0.TopologyTemplate + aria_extension_tosca.simple_v1_0.ServiceTemplate + +Types +----- + +.. autosummary:: + :nosignatures: + + aria_extension_tosca.simple_v1_0.ArtifactType + aria_extension_tosca.simple_v1_0.DataType + aria_extension_tosca.simple_v1_0.CapabilityType + aria_extension_tosca.simple_v1_0.InterfaceType + aria_extension_tosca.simple_v1_0.RelationshipType + aria_extension_tosca.simple_v1_0.NodeType + aria_extension_tosca.simple_v1_0.GroupType + aria_extension_tosca.simple_v1_0.PolicyType + +Data types +---------- + +.. autosummary:: + :nosignatures: + + aria_extension_tosca.simple_v1_0.Timestamp + aria_extension_tosca.simple_v1_0.Version + aria_extension_tosca.simple_v1_0.Range + aria_extension_tosca.simple_v1_0.List + aria_extension_tosca.simple_v1_0.Map + aria_extension_tosca.simple_v1_0.ScalarSize + aria_extension_tosca.simple_v1_0.ScalarTime + aria_extension_tosca.simple_v1_0.ScalarFrequency +""" + from .presenter import ToscaSimplePresenter1_0 from .assignments import (PropertyAssignment, OperationAssignment, InterfaceAssignment, RelationshipAssignment, RequirementAssignment, AttributeAssignment, http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/5be27b0c/extensions/aria_extension_tosca/simple_v1_0/assignments.py ---------------------------------------------------------------------- diff --git a/extensions/aria_extension_tosca/simple_v1_0/assignments.py b/extensions/aria_extension_tosca/simple_v1_0/assignments.py index 79f6377..0590527 100644 --- a/extensions/aria_extension_tosca/simple_v1_0/assignments.py +++ b/extensions/aria_extension_tosca/simple_v1_0/assignments.py @@ -61,7 +61,7 @@ class OperationAssignment(ExtensiblePresentation): """ The optional description string for the associated named operation. - :rtype: :class:`Description` + :type: :class:`Description` """ @object_field(OperationImplementation) @@ -70,7 +70,7 @@ class OperationAssignment(ExtensiblePresentation): The optional implementation artifact name (e.g., a script file name within a TOSCA CSAR file). - :rtype: :class:`OperationImplementation` + :type: :class:`OperationImplementation` """ @object_dict_field(PropertyAssignment) @@ -81,7 +81,7 @@ class OperationAssignment(ExtensiblePresentation): when operation definitions are included as part of a Requirement assignment in a Node Template. - :rtype: dict of str, :class:`PropertyAssignment` + :type: {:obj:`basestring`: :class:`PropertyAssignment`} """ @cachedmethod @@ -124,13 +124,13 @@ class InterfaceAssignment(ExtensiblePresentation): when interface definitions are referenced as part of a Requirement assignment in a Node Template. - :rtype: dict of str, :class:`PropertyAssignment` + :type: {:obj:`basestring`: :class:`PropertyAssignment`} """ @object_dict_unknown_fields(OperationAssignment) def operations(self): """ - :rtype: dict of str, :class:`OperationAssignment` + :type: {:obj:`basestring`: :class:`OperationAssignment`} """ @cachedmethod @@ -157,6 +157,10 @@ class InterfaceAssignment(ExtensiblePresentation): @short_form_field('type') @has_fields class RelationshipAssignment(ExtensiblePresentation): + """ + Relationship assignment. + """ + @field_validator(relationship_template_or_type_validator) @primitive_field(str) def type(self): @@ -164,7 +168,7 @@ class RelationshipAssignment(ExtensiblePresentation): The optional reserved keyname used to provide the name of the Relationship Type for the requirement assignment's relationship keyname. - :rtype: str + :type: :obj:`basestring` """ @object_dict_field(PropertyAssignment) @@ -172,7 +176,7 @@ class RelationshipAssignment(ExtensiblePresentation): """ ARIA NOTE: This field is not mentioned in the spec, but is implied. - :rtype: dict of str, :class:`PropertyAssignment` + :type: {:obj:`basestring`: :class:`PropertyAssignment`} """ @object_dict_field(InterfaceAssignment) @@ -182,7 +186,7 @@ class RelationshipAssignment(ExtensiblePresentation): the corresponding Relationship Type in order to provide Property assignments for these interfaces or operations of these interfaces. - :rtype: dict of str, :class:`InterfaceAssignment` + :type: {:obj:`basestring`: :class:`InterfaceAssignment`} """ @cachedmethod @@ -224,7 +228,7 @@ class RequirementAssignment(ExtensiblePresentation): * Capability Type that the provider will use to select a type-compatible target node template to fulfill the requirement at runtime. - :rtype: str + :type: :obj:`basestring` """ @field_validator(node_template_or_type_validator) @@ -238,7 +242,7 @@ class RequirementAssignment(ExtensiblePresentation): * Node Type name that the provider will use to select a type-compatible node template to fulfill the requirement at runtime. - :rtype: str + :type: :obj:`basestring` """ @object_field(RelationshipAssignment) @@ -251,7 +255,7 @@ class RequirementAssignment(ExtensiblePresentation): * Relationship Type that the provider will use to select a type-compatible relationship template to relate the source node to the target node at runtime. - :rtype: :class:`RelationshipAssignment` + :type: :class:`RelationshipAssignment` """ @field_validator(node_filter_validator) @@ -261,7 +265,7 @@ class RequirementAssignment(ExtensiblePresentation): The optional filter definition that TOSCA orchestrators or providers would use to select a type-compatible target node that can fulfill the associated abstract requirement at runtime. - :rtype: :class:`NodeFilter` + :type: :class:`NodeFilter` """ @cachedmethod @@ -325,7 +329,7 @@ class CapabilityAssignment(ExtensiblePresentation): """ An optional list of property definitions for the Capability definition. - :rtype: dict of str, :class:`PropertyAssignment` + :type: {:obj:`basestring`: :class:`PropertyAssignment`} """ @object_dict_field(AttributeAssignment) @@ -333,7 +337,7 @@ class CapabilityAssignment(ExtensiblePresentation): """ An optional list of attribute definitions for the Capability definition. - :rtype: dict of str, :class:`AttributeAssignment` + :type: {:obj:`basestring`: :class:`AttributeAssignment`} """ @cachedmethod @@ -370,7 +374,7 @@ class ArtifactAssignment(ExtensiblePresentation): """ The required artifact type for the artifact definition. - :rtype: str + :type: :obj:`basestring` """ @primitive_field(str, required=True) @@ -379,7 +383,7 @@ class ArtifactAssignment(ExtensiblePresentation): The required URI string (relative or absolute) which can be used to locate the artifact's file. - :rtype: str + :type: :obj:`basestring` """ @field_validator(type_validator('repository', 'repositories')) @@ -390,7 +394,7 @@ class ArtifactAssignment(ExtensiblePresentation): repository that contains the artifact. The artifact is expected to be referenceable by its file URI within the repository. - :rtype: str + :type: :obj:`basestring` """ @object_field(Description) @@ -398,7 +402,7 @@ class ArtifactAssignment(ExtensiblePresentation): """ The optional description for the artifact definition. - :rtype: :class:`Description` + :type: :class:`Description` """ @primitive_field(str) @@ -406,7 +410,7 @@ class ArtifactAssignment(ExtensiblePresentation): """ The file path the associated file would be deployed into within the target node's container. - :rtype: str + :type: :obj:`basestring` """ @object_dict_field(PropertyAssignment) @@ -414,7 +418,7 @@ class ArtifactAssignment(ExtensiblePresentation): """ ARIA NOTE: This field is not mentioned in the spec, but is implied. - :rtype: dict of str, :class:`PropertyAssignment` + :type: {:obj:`basestring`: :class:`PropertyAssignment`} """ @cachedmethod
