Current File : //usr/lib/python2.7/site-packages/salt/utils/schema.pyc
�
���^c @@ s` d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z
d d l m Z d d l
m Z d Z d Z d e f d � � YZ d
e f d � � YZ e � Z d � Z e e � e _ [ d
e j e e � f d � � YZ d e j e e � f d � � YZ d e j e e � f d � � YZ d e j e e � f d � � YZ d e f d � � YZ d e f d � � YZ d e f d � � YZ d e f d � � YZ! d e! f d � � YZ" d e! f d � � YZ# d! e! f d" � � YZ$ d# e! f d$ � � YZ% d% e! f d& � � YZ& d' e! f d( � � YZ' d) e! f d* � � YZ( d+ e f d, � � YZ) d- e) f d. � � YZ* d/ e f d0 � � YZ+ d1 e f d2 � � YZ, d3 e f d4 � � YZ- d5 e f d6 � � YZ. d7 e. f d8 � � YZ/ d9 e. f d: � � YZ0 d; e f d< � � YZ1 d= e* f d> � � YZ2 d? e f d@ � � YZ3 dA e f dB � � YZ4 d S(C u,
:codeauthor: Pedro Algarvio (pedro@algarvio.me)
:codeauthor: Alexandru Bleotu (alexandru.bleotu@morganstanley.com)
salt.utils.schema
~~~~~~~~~~~~~~~~~
Object Oriented Configuration - JSON Schema compatible generator
This code was inspired by `jsl`__, "A Python DSL for describing JSON
schemas".
.. __: https://jsl.readthedocs.io/
A configuration document or configuration document section is defined using
the py:class:`Schema`, the configuration items are defined by any of the
subclasses of py:class:`BaseSchemaItem` as attributes of a subclass of
py:class:`Schema` class.
A more complex configuration document (containing a defininitions section)
is defined using the py:class:`DefinitionsSchema`. This type of
schema supports having complex configuration items as attributes (defined
extending the py:class:`ComplexSchemaItem`). These items have other
configuration items (complex or not) as attributes, allowing to verify
more complex JSON data structures
As an example:
.. code-block:: python
class HostConfig(Schema):
title = 'Host Configuration'
description = 'This is the host configuration'
host = StringItem(
'Host',
'The looong host description',
default=None,
minimum=1
)
port = NumberItem(
description='The port number',
default=80,
required=False,
minimum=0,
inclusiveMinimum=False,
maximum=65535
)
The serialized version of the above configuration definition is:
.. code-block:: python
>>> print(HostConfig.serialize())
OrderedDict([
('$schema', 'http://json-schema.org/draft-04/schema#'),
('title', 'Host Configuration'),
('description', 'This is the host configuration'),
('type', 'object'),
('properties', OrderedDict([
('host', {'minimum': 1,
'type': 'string',
'description': 'The looong host description',
'title': 'Host'}),
('port', {'description': 'The port number',
'default': 80,
'inclusiveMinimum': False,
'maximum': 65535,
'minimum': 0,
'type': 'number'})
])),
('required', ['host']),
('x-ordering', ['host', 'port']),
('additionalProperties', True)]
)
>>> print(salt.utils.json.dumps(HostConfig.serialize(), indent=2))
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Host Configuration",
"description": "This is the host configuration",
"type": "object",
"properties": {
"host": {
"minimum": 1,
"type": "string",
"description": "The looong host description",
"title": "Host"
},
"port": {
"description": "The port number",
"default": 80,
"inclusiveMinimum": false,
"maximum": 65535,
"minimum": 0,
"type": "number"
}
},
"required": [
"host"
],
"x-ordering": [
"host",
"port"
],
"additionalProperties": false
}
The serialized version of the configuration block can be used to validate a
configuration dictionary using the `python jsonschema library`__.
.. __: https://pypi.python.org/pypi/jsonschema
.. code-block:: python
>>> import jsonschema
>>> jsonschema.validate({'host': 'localhost', 'port': 80}, HostConfig.serialize())
>>> jsonschema.validate({'host': 'localhost', 'port': -1}, HostConfig.serialize())
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/usr/lib/python2.7/site-packages/jsonschema/validators.py", line 478, in validate
cls(schema, *args, **kwargs).validate(instance)
File "/usr/lib/python2.7/site-packages/jsonschema/validators.py", line 123, in validate
raise error
jsonschema.exceptions.ValidationError: -1 is less than the minimum of 0
Failed validating 'minimum' in schema['properties']['port']:
{'default': 80,
'description': 'The port number',
'inclusiveMinimum': False,
'maximum': 65535,
'minimum': 0,
'type': 'number'}
On instance['port']:
-1
>>>
A configuration document can even be split into configuration sections. Let's reuse the above
``HostConfig`` class and include it in a configuration block:
.. code-block:: python
class LoggingConfig(Schema):
title = 'Logging Configuration'
description = 'This is the logging configuration'
log_level = StringItem(
'Logging Level',
'The logging level',
default='debug',
minimum=1
)
class MyConfig(Schema):
title = 'My Config'
description = 'This my configuration'
hostconfig = HostConfig()
logconfig = LoggingConfig()
The JSON Schema string version of the above is:
.. code-block:: python
>>> print salt.utils.json.dumps(MyConfig.serialize(), indent=4)
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "My Config",
"description": "This my configuration",
"type": "object",
"properties": {
"hostconfig": {
"id": "https://non-existing.saltstack.com/schemas/hostconfig.json#",
"title": "Host Configuration",
"description": "This is the host configuration",
"type": "object",
"properties": {
"host": {
"minimum": 1,
"type": "string",
"description": "The looong host description",
"title": "Host"
},
"port": {
"description": "The port number",
"default": 80,
"inclusiveMinimum": false,
"maximum": 65535,
"minimum": 0,
"type": "number"
}
},
"required": [
"host"
],
"x-ordering": [
"host",
"port"
],
"additionalProperties": false
},
"logconfig": {
"id": "https://non-existing.saltstack.com/schemas/logconfig.json#",
"title": "Logging Configuration",
"description": "This is the logging configuration",
"type": "object",
"properties": {
"log_level": {
"default": "debug",
"minimum": 1,
"type": "string",
"description": "The logging level",
"title": "Logging Level"
}
},
"required": [
"log_level"
],
"x-ordering": [
"log_level"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
>>> import jsonschema
>>> jsonschema.validate(
{'hostconfig': {'host': 'localhost', 'port': 80},
'logconfig': {'log_level': 'debug'}},
MyConfig.serialize())
>>> jsonschema.validate(
{'hostconfig': {'host': 'localhost', 'port': -1},
'logconfig': {'log_level': 'debug'}},
MyConfig.serialize())
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/usr/lib/python2.7/site-packages/jsonschema/validators.py", line 478, in validate
cls(schema, *args, **kwargs).validate(instance)
File "/usr/lib/python2.7/site-packages/jsonschema/validators.py", line 123, in validate
raise error
jsonschema.exceptions.ValidationError: -1 is less than the minimum of 0
Failed validating 'minimum' in schema['properties']['hostconfig']['properties']['port']:
{'default': 80,
'description': 'The port number',
'inclusiveMinimum': False,
'maximum': 65535,
'minimum': 0,
'type': 'number'}
On instance['hostconfig']['port']:
-1
>>>
If however, you just want to use the configuration blocks for readability
and do not desire the nested dictionaries serialization, you can pass
``flatten=True`` when defining a configuration section as a configuration
subclass attribute:
.. code-block:: python
class MyConfig(Schema):
title = 'My Config'
description = 'This my configuration'
hostconfig = HostConfig(flatten=True)
logconfig = LoggingConfig(flatten=True)
The JSON Schema string version of the above is:
.. code-block:: python
>>> print(salt.utils.json.dumps(MyConfig, indent=4))
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "My Config",
"description": "This my configuration",
"type": "object",
"properties": {
"host": {
"minimum": 1,
"type": "string",
"description": "The looong host description",
"title": "Host"
},
"port": {
"description": "The port number",
"default": 80,
"inclusiveMinimum": false,
"maximum": 65535,
"minimum": 0,
"type": "number"
},
"log_level": {
"default": "debug",
"minimum": 1,
"type": "string",
"description": "The logging level",
"title": "Logging Level"
}
},
"x-ordering": [
"host",
"port",
"log_level"
],
"additionalProperties": false
}
i ( t absolute_importt print_functiont unicode_literalsN( t OrderedDict( t sixu* https://non-existing.saltstack.com/schemasiP t Prepareablec B@ s# e Z d Z e j s! d � Z n RS( u2
Preserve attributes order for python 2.x
c @ ss y | d � Wn$ t k
r4 t j | | | | � SX� f d � } t j � � | � | d <t j | | | | � S( Nu __new__c
@ s y | j Wn! t k
r. � | | | | � SX| j | | � } t j d � } x^ t | j j � D]7 } t j | � rc | j | k rc | j
d � � Pqc qc W� | | | | � St | j � d � f d � �} x | D] \ } } | | | <q� W� | | | | � S( Ni c S@ s* y | j | � SWn t k
r% d SXd S( Ni ( t indext
ValueError( t attribute_namet _names( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt get_indexl s
t keyc @ s � | d � S( Ni ( ( t item( R
( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt <lambda>v s (
t __prepare__t AttributeErrort syst _getframet reversedt f_codet co_constst inspectt iscodet co_namet co_namest sortedt items(
t mcst namet basest
attributest namespacet defining_framet constantt
by_appearanceR t value( t constructor( R
s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt preparing_constructorc s
( t KeyErrort typet __new__t functoolst wraps( R R R R R% ( ( R$ s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR( ] s
( t __name__t
__module__t __doc__R t PY3R( ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR U s t NullSentinelc B@ s e Z d Z d � Z e Z RS( ut
A class which instance represents a null value.
Allows specifying fields with a default value of null.
c C@ s t S( N( t False( t self( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt __bool__� s ( R+ R, R- R2 t __nonzero__( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR/ s c O@ s t d � � d S( Nu* Can't create another NullSentinel instance( t TypeError( t argst kwargs( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt _failing_new� s t
SchemaMetac B@ s/ e Z e d � � Z d � Z e e d � Z RS( c C@ s t � S( N( R ( R R R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR � s c C@ s� t | d <t | d <d | d <i } i } g } xz t | � D]l } t | d � re | j | j � n t | d � r� | j | j � n t | d � r= | j | j � q= q= Wx� t
j | � D]� \ } } d }
t | d � r� t | d � r� q� n t | d � rJt | d � r.| j d k r.| | _ n | j
p:| }
| | |
<n t | d � ru| j pe| }
| | |
<n | j |
� q� W| | d <| | d <| | d <t j | | | | � S( Nu
__config__u __flatten__u __config_name__u _itemsu _sectionsu _orderu __item__u title( t TrueR0 t NoneR t hasattrt updatet _itemst _sectionst extendt _orderR t iteritemst titlet
__item_name__t __config_name__t appendR' R( ( R R R t attrsR t sectionst ordert baseR R# t
entry_name( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR( � s<
c K@ se t j | � } | j d d � | _ | t k r< t | _ n | t k rT t | _ n | j | � | S( Nu name( t objectR( t popR: RD R9 t __flatten__t __allow_additional_items__t __init__( t clst flattent allow_additional_itemsR6 t instance( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt __call__� s
( R+ R, t classmethodR R( R0 RT ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR8 � s *t BaseSchemaItemMetac B@ s/ e Z d Z e d � � Z d � Z d � Z RS( uJ
Config item metaclass to "tag" the class as a configuration item
c C@ s t � S( N( R ( R R R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR � s c C@ s� t | d <d | d <g } x� t | � D]� } y� t | d g � } | rX | j | � n x` t j j j | j � j D]C } | d k st | | k r� qt n | d k r� qt n | j
| � qt WWq' t k
r� q' q' Xq' W| | d <t j
| | | | � S( Nu __item__u
__item_name__u _attributesu selfu name( R9 R: R t getattrR? t saltt utilsR5 t get_function_argspecRO RE R4 R' R( ( R R R RF R RI t base_attributest argname( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR( � s$
"
c O@ s t j | � } | r$ t d � � n xZ | j � D]L } | d k r[ | j | � | _ q1 n | | j k r1 | j j | � q1 q1 W| j | | � x` t t
j | � � D]I } t | d d � } | r� | j j j | j k r� | j | � q� q� q� W| j � | S( NuR Please pass all arguments as named arguments. Un-named arguments are not supportedu nameu __validate_attributes__( RK R( t RuntimeErrort copyRL RC t _attributesRE RO R R t getmroRW R: t __validate_attributes__t __func__t __code__( RP R5 R6 RS R RI t validate_attributes( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRT � s$
( R+ R, R- RU R R( RT ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRV � s t Schemac B@ sd e Z d Z d Z d Z d Z Z Z e Z
e Z e d d � � Z
e d � � Z e d � � Z RS( u(
Configuration definition class
c C@ s� t � } | d k r. d j t | � | d <n
d | d <| j d k rW | j | d <n | j d k r� | j | j k r� t j | j � j � | d <q� | j | d <n g } g } d | d <t � } g | _
x�| j D]�} t } d } | | j
k r�| j
| } | j | j t k r"d n | � }
| j t k r�| j |
d � d
|
k rk| j |
d
� n d |
k r�| j |
d � n t | d � r�| j
j | j
� n t } q�|
| | <n | | j k rQ| j | } | j p�| } | j t k r%| j � } | j
j | � t } n | j � | | <| j rQ| j | � qQn | t k r� | d k r�| | k r�| j | � q�q�| | k r�| j | � q�q� q� W| r�| | d <n | j
r`i }
xq | j
D]f } x] t j | � D]L \ } } | |
k r/t |
| t � r9|
| j | � q9q�| |
| <q�Wq�W|
r`|
j | � |
} q`n | rs| | d <n | r�| | d
<n | j | d
<| S( Nu
{0}/{1}.json#u idu' http://json-schema.org/draft-04/schema#u $schemau titleu descriptionu objectu typeu
propertiesu
x-orderingu requiredu after_items_updateu additionalProperties( R R: t formatt BASE_SCHEMA_URLRB t descriptionR- t textwrapt dedentt stript after_items_updateR@ R0 R> t serializeRM R9 R< R? R; R= RC RE t requiredR RA t
isinstancet listRN ( RP t id_t
serializedRn t orderingt
propertiesR t
skip_ordert item_namet sectiont serialized_sectiont configt serialized_configRl t entryt data( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRm + s�
$
c C@ s� | j � } i } x� | d j � D]� \ } } d | k rO | d | | <q# n d | k r# xG | d j � D]5 \ } } d | k rl | d | j | i � | <ql ql Wq# q# q# W| S( Nu
propertiesu default( Rm R t
setdefault( RP Rr t defaultsR t detailst snamet sdetails( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR~ � s !
c C@ s\ | j � } | j d g � } x. | d D]" } | | k r) | j | � q) q) Wt d | � S( Nu requiredu
propertiest requirements( Rm t getRE t RequirementsItem( RP t serialized_schemaRn R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt as_requirements_item� s N( R+ R, R- R: RB Rh R= R> R@ R0 RM RN RU Rm R~ R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRe s ^t
SchemaItemc B@ sY e Z d Z d Z d Z d Z e Z d Z e Z
d d � Z d � Z d � Z
d � Z RS( uR
Base configuration items class.
All configurations must subclass it
c K@ s% | d k r | | _ n | | _ d S( u`
:param required: If the configuration item is required. Defaults to ``False``.
N( R: Rn t extra( R1 Rn R� ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO � s c C@ s( | j t t f k r$ t d � � n d S( u
Run any validation check you need the instance attributes.
ATTENTION:
Don't call the parent class when overriding this
method because it will just duplicate the executions. This class'es
metaclass will take care of that.
u! 'required' can only be True/FalseN( Rn R9 R0 R] ( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRa � s
c C@ s� t | d j | � d � } | d k r? t | � r? | � } n | d k r` t | | d � } n | d k r� t | d j | � d � } n | d k r� | j j | d � } n | S( uP
Return the argname value looking up on all possible attributes
u __get_{0}__u __{0}__N( RW Rf R: t callableR� R� ( R1 R\ t argvalue( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt _get_argname_value� s c C@ s
t � d S( uC
Return a serializable form of the config instance
N( t NotImplementedError( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRm � s N( R+ R, R- R: t __type__t
__format__R_ R0 RM t __serialize_attr_aliases__Rn RO Ra R� Rm ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t BaseSchemaItemc B@ s_ e Z d Z d Z d Z d Z d Z d Z d d d d d d � Z d � Z
d � Z d � Z RS( uR
Base configuration items class.
All configurations must subclass it
c K@ s� | d k r | | _ n | d k r0 | | _ n | d k rH | | _ n | d k r` | | _ n | d k rx | | _ n t t | � j | � d S( uA
:param required:
If the configuration item is required. Defaults to ``False``.
:param title:
A short explanation about the purpose of the data described by this item.
:param description:
A detailed explanation about the purpose of the data described by this item.
:param default:
The default value for this configuration item. May be :data:`.Null` (a special value
to set the default value to null).
:param enum:
A list(list, tuple, set) of valid choices.
N( R: RB Rh t defaultt enumt enumNamest superR� RO ( R1 RB Rh R� R� R� R6 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO s c C@ s� | j d k rc t | j t t t f � s9 t d � � n t | j t � sc t | j � | _ qc n | j d k r� t | j t t t f � s� t d � � n t | j � t | j � k r� t d � � n t | j t � s� t | j � | _ q� n d S( NuL Only the 'list', 'tuple' and 'set' python types can be used to define 'enum'uQ Only the 'list', 'tuple' and 'set' python types can be used to define 'enumNames'u5 The size of 'enumNames' must match the size of 'enum'( R� R: Ro Rp t tuplet setR] R� t len( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRa % s c C@ s� i | j d 6} x� | j D]} } | d k r2 q n | j | � } | d k r | t k rb d } n | j r� | | j k r� | j | } n | | | <q q W| S( uC
Return a serializable form of the config instance
u typeu requiredN( R� R_ R� R: t NullR� ( R1 Rr R\ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRm ; s c C@ sB | j d k r> | j | j k r7 t j | j � j � S| j Sd S( N( Rh R: R- Ri Rj Rk ( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt __get_description__O s N(
R+ R, R- R: Rh RB R� R� R� RO Ra Rm R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s
t NullItemc B@ s e Z d Z RS( u null( R+ R, R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� u s t BooleanItemc B@ s e Z d Z RS( u boolean( R+ R, R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� z s t
StringItemc B@ s^ e Z d Z d Z i d d 6d d 6Z d Z d Z d Z d Z d d d d d � Z
d � Z RS( u&
A string configuration field
u stringu minLengthu
min_lengthu maxLengthu
max_lengthc K@ sz | d k r | | _ n | d k r0 | | _ n | d k rH | | _ n | d k r` | | _ n t t | � j | � d S( u�
:param required:
If the configuration item is required. Defaults to ``False``.
:param title:
A short explanation about the purpose of the data described by this item.
:param description:
A detailed explanation about the purpose of the data described by this item.
:param default:
The default value for this configuration item. May be :data:`.Null` (a special value
to set the default value to null).
:param enum:
A list(list, tuple, set) of valid choices.
:param format:
A semantic format of the string (for example, ``"date-time"``, ``"email"``, or ``"uri"``).
:param pattern:
A regular expression (ECMA 262) that a string value must match.
:param min_length:
The minimum length
:param max_length:
The maximum length
N( R: Rf t patternt
min_lengtht
max_lengthR� R� RO ( R1 Rf R� R� R� R6 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO � s c C@ s1 | j d k r- | j d k r- | j | _ n d S( N( Rf R: R� ( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRa � s N( R+ R, R- R� R� R: Rf R� R� R� RO Ra ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� ~ s
!t EMailItemc B@ s e Z d Z d Z RS( ut
An internet email address, see `RFC 5322, section 3.4.1`__.
.. __: http://tools.ietf.org/html/rfc5322
u email( R+ R, R- R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t IPv4Itemc B@ s e Z d Z d Z RS( u�
An IPv4 address configuration field, according to dotted-quad ABNF syntax as defined in
`RFC 2673, section 3.2`__.
.. __: http://tools.ietf.org/html/rfc2673
u ipv4( R+ R, R- R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t IPv6Itemc B@ s e Z d Z d Z RS( u�
An IPv6 address configuration field, as defined in `RFC 2373, section 2.2`__.
.. __: http://tools.ietf.org/html/rfc2373
u ipv6( R+ R, R- R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t HostnameItemc B@ s e Z d Z d Z RS( u�
An Internet host name configuration field, see `RFC 1034, section 3.1`__.
.. __: http://tools.ietf.org/html/rfc1034
u hostname( R+ R, R- R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t DateTimeItemc B@ s e Z d Z d Z RS( u�
An ISO 8601 formatted date-time configuration field, as defined by `RFC 3339, section 5.6`__.
.. __: http://tools.ietf.org/html/rfc3339
u date-time( R+ R, R- R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t UriItemc B@ s e Z d Z d Z RS( u�
A universal resource identifier (URI) configuration field, according to `RFC3986`__.
.. __: http://tools.ietf.org/html/rfc3986
u uri( R+ R, R- R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t
SecretItemc B@ s e Z d Z d Z RS( ua
A string configuration field containing a secret, for example, passwords, API keys, etc
u secret( R+ R, R- R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t
NumberItemc B@ s_ e Z d Z i d d 6d d 6d d 6Z d Z d Z d Z d Z d Z d d d d d d � Z
RS( u numberu
multipleOfu multiple_ofu exclusiveMinimumu exclusive_minimumu exclusiveMaximumu exclusive_maximumc K@ s� | d k r | | _ n | d k r0 | | _ n | d k rH | | _ n | d k r` | | _ n | d k rx | | _ n t t | � j | � d S( u�
:param required:
If the configuration item is required. Defaults to ``False``.
:param title:
A short explanation about the purpose of the data described by this item.
:param description:
A detailed explanation about the purpose of the data described by this item.
:param default:
The default value for this configuration item. May be :data:`.Null` (a special value
to set the default value to null).
:param enum:
A list(list, tuple, set) of valid choices.
:param multiple_of:
A value must be a multiple of this factor.
:param minimum:
The minimum allowed value
:param exclusive_minimum:
Whether a value is allowed to be exactly equal to the minimum
:param maximum:
The maximum allowed value
:param exclusive_maximum:
Whether a value is allowed to be exactly equal to the maximum
N( R: t multiple_oft minimumt exclusive_minimumt maximumt exclusive_maximumR� R� RO ( R1 R� R� R� R� R� R6 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO s N( R+ R, R� R� R: R� R� R� R� R� RO ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s
t IntegerItemc B@ s e Z d Z RS( u integer( R+ R, R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� 2 s t ArrayItemc B@ sx e Z d Z i d d 6d d 6d d 6d d 6Z d Z d Z d Z d Z d Z d d d d d d � Z
d
� Z d � Z RS(
u arrayu minItemsu min_itemsu maxItemsu max_itemsu uniqueItemsu unique_itemsu additionalItemsu additional_itemsc K@ s� | d k r | | _ n | d k r0 | | _ n | d k rH | | _ n | d k r` | | _ n | d k rx | | _ n t t | � j | � d S( u�
:param required:
If the configuration item is required. Defaults to ``False``.
:param title:
A short explanation about the purpose of the data described by this item.
:param description:
A detailed explanation about the purpose of the data described by this item.
:param default:
The default value for this configuration item. May be :data:`.Null` (a special value
to set the default value to null).
:param enum:
A list(list, tuple, set) of valid choices.
:param items:
Either of the following:
* :class:`BaseSchemaItem` -- all items of the array must match the field schema;
* a list or a tuple of :class:`fields <.BaseSchemaItem>` -- all items of the array must be
valid according to the field schema at the corresponding index (tuple typing);
:param min_items:
Minimum length of the array
:param max_items:
Maximum length of the array
:param unique_items:
Whether all the values in the array must be distinct.
:param additional_items:
If the value of ``items`` is a list or a tuple, and the array length is larger than
the number of fields in ``items``, then the additional items are described
by the :class:`.BaseField` passed using this argument.
:type additional_items: bool or :class:`.BaseSchemaItem`
N( R: R t min_itemst max_itemst unique_itemst additional_itemsR� R� RO ( R1 R R� R� R� R� R6 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO F s $ c C@ s� | j r# | j r# t d � � n | j d k r� t | j t t f � r� x� | j D]9 } t | t t f � sT t d j t
| � � � � qT qT Wq� t | j t t f � s� t d j t
| j � � � � q� n d S( Nu0 One of items or additional_items must be passed.ut All items passed in the item argument tuple/list must be a subclass of Schema, SchemaItem or BaseSchemaItem, not {0}u] The items argument passed must be a subclass of Schema, SchemaItem or BaseSchemaItem, not {0}( R R� R] R: Ro Rp R� Re R� Rf R' ( R1 R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRa v s c C@ sr t | j t t f � r% | j j � St | j t t f � rn g } x$ | j D] } | j | j � � qM W| Sd S( N( Ro R Re R� Rm R� Rp RE ( R1 R R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt
__get_items__� s
N(
R+ R, R� R� R: R R� R� R� R� RO Ra R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� 6 s$
+ t DictItemc B@ s� e Z d Z i d d 6d d 6d d 6d d 6Z d Z d Z d Z d Z d Z d d d d d d � Z
d
� Z d � Z d � Z
d
� Z e d � Z d � Z RS( u objectu
minPropertiesu min_propertiesu
maxPropertiesu max_propertiesu patternPropertiesu pattern_propertiesu additionalPropertiesu additional_propertiesc K@ s� | d k r | | _ n | d k r0 | | _ n | d k rH | | _ n | d k r` | | _ n | d k rx | | _ n t t | � j | � d S( u~
:param required:
If the configuration item is required. Defaults to ``False``.
:type required:
boolean
:param title:
A short explanation about the purpose of the data described by this item.
:type title:
str
:param description:
A detailed explanation about the purpose of the data described by this item.
:param default:
The default value for this configuration item. May be :data:`.Null` (a special value
to set the default value to null).
:param enum:
A list(list, tuple, set) of valid choices.
:param properties:
A dictionary containing fields
:param pattern_properties:
A dictionary whose keys are regular expressions (ECMA 262).
Properties match against these regular expressions, and for any that match,
the property is described by the corresponding field schema.
:type pattern_properties: dict[str -> :class:`.Schema` or
:class:`.SchemaItem` or :class:`.BaseSchemaItem`]
:param additional_properties:
Describes properties that are not described by the ``properties`` or ``pattern_properties``.
:type additional_properties: bool or :class:`.Schema` or :class:`.SchemaItem`
or :class:`.BaseSchemaItem`
:param min_properties:
A minimum number of properties.
:type min_properties: int
:param max_properties:
A maximum number of properties
:type max_properties: int
N( R: Rt t pattern_propertiest additional_propertiest min_propertiest max_propertiesR� R� RO ( R1 Rt R� R� R� R� R6 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO � s * c C@ s� | j r- | j r- | j r- t d � � n | j d k r� t | j t t f � su t d j t | j � � � � n t | j t � s� xV | j j
� D]B \ } } t | t t f � s� t d j | t | � � � � q� q� Wq� n | j d k r~t | j t � s%t d j t | j � � � � n xV | j j
� D]B \ } } t | t t f � s5t d j | t | � � � � q5q5Wn | j d k r�t | j t t t f � s�t d j t | j � � � � q�n d S( NuM One of properties, pattern_properties or additional_properties must be passeduE The passed properties must be passed as a dict or a Schema not '{0}'uf The passed property who's key is '{0}' must be of type Schema, SchemaItem or BaseSchemaItem, not '{1}'u@ The passed pattern_properties must be passed as a dict not '{0}'un The passed pattern_property who's key is '{0}' must be of type Schema, SchemaItem or BaseSchemaItem, not '{1}'uf The passed additional_properties must be of type bool, Schema, SchemaItem or BaseSchemaItem, not '{0}'(
Rt R� R� R] R: Ro Re t dictRf R' R R� t bool( R1 R t prop( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRa � s: " c C@ ss | j d k r d St | j t � r6 | j j � d St � } x- | j j � D] \ } } | j � | | <qO W| S( Nu
properties( Rt R: Ro Re Rm R R ( R1 Rt R R� ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt __get_properties__ s c C@ sP | j d k r d St � } x- | j j � D] \ } } | j � | | <q, W| S( N( R� R: R R Rm ( R1 R� R R� ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt __get_pattern_properties__ s c C@ s9 | j d k r d St | j t � r, | j S| j j � S( N( R� R: Ro R� Rm ( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt __get_additional_properties__ s
c C@ s
| | _ | S( N( RM ( R1 RQ ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRT s c C@ s� t t | � j � } g } | j d k r� t | j t � rn | j j � } d | k r� | j | d � q� q� x9 | j j � D]% \ } } | j r~ | j
| � q~ q~ Wn | r� | | d <n | S( Nu required( R� R� Rm Rt R: Ro Re R? R Rn RE ( R1 t resultRn Rr R R� ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRm $ s
N( R+ R, R� R� R: Rt R� R� R� R� RO Ra R� R� R� R0 RT Rm ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s,
1 )
R� c B@ s2 e Z d Z d Z d d � Z d � Z d � Z RS( u objectc C@ s/ | d k r | | _ n t t | � j � d S( N( R: R� R� R� RO ( R1 R� ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO : s c C@ s� | j d k r t d � � n t | j t t t t f � sW t d j | j � � � n t | j t � s� t | j t � s� t | j � | _ n xY t | j � D]E \ } } t | t
j t f � s� t d j | t | � � � � q� q� Wn d S( Nu) The passed requirements must not be emptyud The passed requirements must be passed as a list, tuple, set SchemaItem or BaseSchemaItem, not '{0}'uT The passed requirement at the {0} index must be of type str or SchemaItem, not '{1}'(
R� R: R] Ro R� Rp R� R� Rf t enumerateR t string_typesR' ( R1 t idxR ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRa ? s c C@ s~ t | j t � r$ | j j � } nO g } xF | j D]; } t | t � rb | j | j � � q4 n | j | � q4 Wi | d 6S( Nu required( Ro R� R� Rm RE ( R1 R� t requirement( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRm U s N( R+ R, R� R: R� RO Ra Rm ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� 5 s
t OneOfItemc B@ sA e Z d Z d Z d d d � Z d � Z e d � Z d � Z RS( u oneOfc C@ s5 | d k r | | _ n t t | � j d | � d S( NRn ( R: R R� R� RO ( R1 R Rn ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO h s c C@ s� | j s t d � � n t | j t t f � sQ t d j t | j � � � � n xS t | j � D]B \ } } t | t t f � sa t d j | t | � � � � qa qa Wt | j t � s� t | j � | _ n d S( Nu" The passed items must not be emptyu9 The passed items must be passed as a list/tuple not '{0}'u` The passed item at the {0} index must be of type Schema, SchemaItem or BaseSchemaItem, not '{1}'(
R R] Ro Rp R� Rf R' R� Re R� ( R1 R� R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRa m s c C@ s
| | _ | S( N( RM ( R1 RQ ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRT � s c C@ s* i g | j D] } | j � ^ q
| j 6S( N( R Rm R� ( R1 t i( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRm � s N(
R+ R, R� R: R RO Ra R0 RT Rm ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� b s t AnyOfItemc B@ s e Z d Z RS( u anyOf( R+ R, R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t AllOfItemc B@ s e Z d Z RS( u allOf( R+ R, R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t NotItemc B@ s2 e Z d Z d Z d d � Z d � Z d � Z RS( u notc C@ s/ | d k r | | _ n t t | � j � d S( N( R: R R� R� RO ( R1 R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO � s c C@ sU | j s t d � � n t | j t t f � sQ t d j t | j � � � � n d S( Nu An item must be passeduJ The passed item be of type Schema, SchemaItem or BaseSchemaItem, not '{0}'( R R] Ro Re R� Rf R' ( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRa � s c C@ s i | j j � | j 6S( N( R Rm R� ( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRm � s N( R+ R, R� R: R RO Ra Rm ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s
t PortItemc B@ s e Z d Z d Z RS( i i�� ( R+ R, R� R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t ComplexSchemaItemc B@ s\ e Z d Z g Z d Z d d d � Z d � Z e d � � Z d � Z
d � Z d � Z RS( u>
.. versionadded:: 2016.11.0
Complex Schema Item
c C@ sK t t | � j d | � d | _ | r. | n | j j | _ | j � d S( NRn u object( R� R� RO R� t __class__R+ t _definition_namet _add_missing_schema_attributes( R1 t definition_nameRn ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRO � s
c C@ s� x g t | � D] } | j d � s | ^ q D]O } t | | � } t t | | � t � r/ | | j k r/ | j j | � q/ q/ Wd S( u�
Adds any missed schema attributes to the _attributes list
The attributes can be class attributes and they won't be
included in the _attributes list automatically
u __N( t dirt
startswithRW Ro R� R_ RE ( R1 t attrt attr_val( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s
5c C@ s | j S( N( R� ( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s c C@ s i d j | j � d 6S( uc
The serialization of the complex item is a pointer to the item
definition
u #/definitions/{0}u $ref( Rf R� ( R1 ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRm � s c C@ s� t t | � j � } | d =| j | d <i } g } xy | j D]n } t | | � } | r? t | t � r? | | =| j � | | <| j | | d <| j r� | j
| � q� q? q? W| j d � d k r� i | d <n | d j
| � | r� | | d <n | S( u* Returns the definition of the complex itemu definition_nameu titleu typeu
propertiesu requiredN( R� R� Rm R� R_ RW Ro R� R� Rn RE R� R: R< ( R1 Rr Rt t required_attr_namest attr_nameR� ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt get_definition� s&
c C@ s; g | j D]- } t t | | � t � r
t | | � ^ q
S( u. Returns a dictionary of the complex attributes( R_ Ro RW R� ( R1 R� ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt get_complex_attrs� s N(
R+ R, R- R_ R: R� RO R� t propertyR� Rm R� R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� � s t DefinitionsSchemac B@ s e Z d Z e d d � � Z RS( u
.. versionadded:: 2016.11.0
JSON schema class that supports ComplexSchemaItem objects by adding
a definitions section to the JSON schema, containing the item definitions.
All references to ComplexSchemaItems are built using schema inline
dereferencing.
c C@ s� t t | � j | � } g } | j j � } t j rE t | � } n x� | r8| j d � } t | t
� r� | j | � | j | j
� � n t | t � r� | j | j � qH t | t � r� | j | j � qH t | t � rH | j r| j | j j � � n | j r5t | j t � r5| j | j � q5qH qH Wt � } x3 | D]+ } t | t
� rI| j � | | j <qIqIW| | d <| S( Ni u definitions( R� R� Rm R= t valuesR R. Rp RL Ro R� RE R? R� R� R R� R� Rt R� R� R R� R� ( RP Rq Rr t
complex_itemst aux_itemsR t definitionsRy ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyRm s4
N( R+ R, R- RU R: Rm ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyR� s (5 R- t
__future__R R R R R Ri R) t salt.utils.argsRX t salt.utils.odictR t salt.extR Rg t# RENDER_COMMENT_YAML_MAX_LINE_LENGTHR' R RK R/ R� R7 t staticmethodR( t with_metaclassR8 RV Re R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/schema.pyt <module>A sV * "A"C"�"B�;
;a�-'Q
Mini Shell