yamlloader

https://phynix.github.io/yamlloader/
Admin
yamlloader provides YAML loaders and dumpers for PyYAML that preserve the order of dictionary keys...
Tokens:2,881
Snippets:37
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### OrderedLoaderMixin Initialization

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/loaders.html

This mixin class initializes the loader by adding constructors for 'tag:yaml.org,2002:map' and 'tag:yaml.org,2002:omap' to use the `construct_yaml_map` method, ensuring ordered dictionary behavior.

```python
class OrderedLoaderMixin(object):
    def __init__(self, *args, **kwargs):
        super(OrderedLoaderMixin, self).__init__(*args, **kwargs)

        self.add_constructor('tag:yaml.org,2002:map', type(self).construct_yaml_map)
        self.add_constructor('tag:yaml.org,2002:omap', type(self).construct_yaml_map)

    construct_yaml_map = construct_yaml_map
    construct_mapping = construct_mapping
```

--------------------------------

### CDumper with OrderedDict Support (if available)

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

The C version of the Dumper, inheriting from OrderedDumperMixin and yaml.CDumper. This is preferred for performance if the C extension is available.

```python
class CDumper(OrderedDumperMixin, yaml.CDumper):
    __doc__ = doc_extension_Cversion
```

--------------------------------

### YAML Loader with OrderedDict Support

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/loaders.html

A standard YAML loader that inherits from OrderedLoaderMixin and yaml.Loader, enabling it to parse YAML maps into ordered dictionaries.

```python
class Loader(OrderedLoaderMixin, yaml.Loader):
    pass
```

--------------------------------

### CSafeDumper with OrderedDict Support (if available)

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

The C version of the SafeDumper, inheriting from OrderedDumperMixin and yaml.CSafeDumper. This is preferred for performance if the C extension is available.

```python
class CSafeDumper(OrderedDumperMixin, yaml.CSafeDumper):
    __doc__ = doc_extension_Cversion
```

--------------------------------

### C Safe Loader with OrderedDict Support

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/loaders.html

A C-based safe YAML loader inheriting from OrderedLoaderMixin and yaml.CSafeLoader. It falls back to the SafeLoader if CSafeLoader is unavailable and non-C fallback is permitted.

```python
if not hasattr(yaml, 'CSafeLoader') and yamlloader.settings.ALLOW_NON_C_FALLBACK:
    yaml.CSafeLoader = yaml.SafeLoader


class CSafeLoader(OrderedLoaderMixin, yaml.CSafeLoader):
    pass
```

--------------------------------

### C Loader with OrderedDict Support

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/loaders.html

A C-based YAML loader that inherits from OrderedLoaderMixin and yaml.CLoader. It falls back to the standard Loader if CLoader is not available and non-C fallback is allowed.

```python
if not hasattr(yaml, 'CLoader') and yamlloader.settings.ALLOW_NON_C_FALLBACK:
    yaml.CLoader = yaml.Loader


class CLoader(OrderedLoaderMixin, yaml.CLoader):
    pass
```

--------------------------------

### CDumper

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

The C-accelerated YAML dumper with ordered dumping capabilities, inheriting from OrderedDumperMixin and yaml.CDumper.

```APIDOC
## Class: CDumper

### Description
This class provides a C-accelerated YAML dumper with ordered dumping capabilities. It inherits from `OrderedDumperMixin` and `yaml.CDumper`. The C version is preferred for performance.

### Inheritance
- `OrderedDumperMixin`
- `yaml.CDumper`
```

--------------------------------

### Dumper with OrderedDict Support

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

A standard Dumper that inherits from OrderedDumperMixin and yaml.Dumper to support ordered dictionaries.

```python
class Dumper(OrderedDumperMixin, yaml.Dumper):
    pass
```

--------------------------------

### Construct Mapping with OrderedDict Support

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/loaders.html

This function constructs a mapping, prioritizing OrderedDict for key order preservation on Python versions 3.6 and below. It includes error handling for unacceptable keys.

```python
def construct_mapping(self, node, deep=False):
    if isinstance(node, yaml.MappingNode):
        self.flatten_mapping(node)
    else:
        msg = 'Expected a mapping node, but found {}'.format(node.id)
        raise yaml.constructor.ConstructError(None, None, msg, node.start_mark)

    if yamlloader.settings.PY_LE_36:
        mapping = OrderedDict()
    else:
        mapping = dict()
    for key_node, value_node in node.value:
        key = self.construct_object(key_node, deep=deep)
        try:
            hash(key)
        except TypeError as err:
            raise yaml.constructor.ConstructError('while constructing a mapping', node.start_mark,
                                                  'found unacceptable key ({})'.format(err),
                                                  key_node.start_mark)
        value = self.construct_object(value_node, deep=deep)
        mapping[key] = value
    return mapping
```

--------------------------------

### Loader

Source: https://phynix.github.io/yamlloader/yamlloader.ordereddict.html

YAML loader that preserves key order, using the standard PyYAML loader.

```APIDOC
## Loader

### Description
YAML loader that preserves key order, using the standard PyYAML loader.

### Class Signature
`yamlloader.ordereddict.Loader(*args, **kwargs)`

### Inheritance
Bases: `yamlloader.ordereddict.loaders.OrderedLoaderMixin`, `yaml.loader.Loader`
```

--------------------------------

### CDumper

Source: https://phynix.github.io/yamlloader/yamlloader.ordereddict.html

YAML dumper that preserves key order, using the C-optimized PyYAML dumper. The C version is preferable over the non-C version as they do equivalent things while the C version is faster.

```APIDOC
## CDumper

### Description
YAML dumper that preserves key order, using the C-optimized PyYAML dumper. The C version is preferable over the non-C version as they do equivalent things while the C version is faster.

### Class Signature
`yamlloader.ordereddict.CDumper(*args, **kwargs)`

### Inheritance
Bases: `yamlloader.ordereddict.dumpers.OrderedDumperMixin`, `yaml.cyaml.CDumper`
```

--------------------------------

### Safe YAML Loader with OrderedDict Support

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/loaders.html

A safe YAML loader that inherits from OrderedLoaderMixin and yaml.SafeLoader, providing secure parsing of YAML maps into ordered dictionaries.

```python
class SafeLoader(OrderedLoaderMixin, yaml.SafeLoader):
    pass
```

--------------------------------

### CSafeDumper

Source: https://phynix.github.io/yamlloader/yamlloader.ordereddict.html

Safe YAML dumper that preserves key order, using the C-optimized PyYAML safe dumper. The C version is preferable over the non-C version as they do equivalent things while the C version is faster.

```APIDOC
## CSafeDumper

### Description
Safe YAML dumper that preserves key order, using the C-optimized PyYAML safe dumper. The C version is preferable over the non-C version as they do equivalent things while the C version is faster.

### Class Signature
`yamlloader.ordereddict.CSafeDumper(*args, **kwargs)`

### Inheritance
Bases: `yamlloader.ordereddict.dumpers.OrderedDumperMixin`, `yaml.cyaml.CSafeDumper`
```

--------------------------------

### SafeDumper with OrderedDict Support

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

A SafeDumper that inherits from OrderedDumperMixin and yaml.SafeDumper, providing safe dumping of ordered dictionaries.

```python
class SafeDumper(OrderedDumperMixin, yaml.SafeDumper):
    __doc__ = """
    """
```

--------------------------------

### CLoader

Source: https://phynix.github.io/yamlloader/yamlloader.ordereddict.html

YAML loader that preserves key order, using the C-optimized PyYAML loader.

```APIDOC
## CLoader

### Description
YAML loader that preserves key order, using the C-optimized PyYAML loader.

### Class Signature
`yamlloader.ordereddict.CLoader(*args, **kwargs)`

### Inheritance
Bases: `yamlloader.ordereddict.loaders.OrderedLoaderMixin`, `yaml.cyaml.CLoader`
```

--------------------------------

### OrderedDumperMixin

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

A mixin class that adds support for dumping OrderedDict and dict (py37+) to YAML while preserving order.

```APIDOC
## Class: OrderedDumperMixin

### Description
A mixin class that adds support for dumping OrderedDict and dict (py37+) to YAML while preserving order. It registers representers for these types with the YAML dumper.

### Methods
#### __init__(self, *args, **kwargs)
Initializes the dumper, setting up the representers for OrderedDict and dict.

#### represent_ordereddict(self, data)
Static method to represent OrderedDict or dict as a YAML mapping, preserving item order.
```

--------------------------------

### CSafeLoader

Source: https://phynix.github.io/yamlloader/yamlloader.ordereddict.html

Safe YAML loader that preserves key order, using the C-optimized PyYAML safe loader.

```APIDOC
## CSafeLoader

### Description
Safe YAML loader that preserves key order, using the C-optimized PyYAML safe loader.

### Class Signature
`yamlloader.ordereddict.CSafeLoader(*args, **kwargs)`

### Inheritance
Bases: `yamlloader.ordereddict.loaders.OrderedLoaderMixin`, `yaml.cyaml.CSafeLoader`
```

--------------------------------

### SafeLoader

Source: https://phynix.github.io/yamlloader/yamlloader.ordereddict.html

Safe YAML loader that preserves key order, using the standard PyYAML safe loader.

```APIDOC
## SafeLoader

### Description
Safe YAML loader that preserves key order, using the standard PyYAML safe loader.

### Class Signature
`yamlloader.ordereddict.SafeLoader(*args, **kwargs)`

### Inheritance
Bases: `yamlloader.ordereddict.loaders.OrderedLoaderMixin`, `yaml.loader.SafeLoader`
```

--------------------------------

### Dumper

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

A YAML dumper that inherits from OrderedDumperMixin and yaml.Dumper, providing ordered dumping capabilities.

```APIDOC
## Class: Dumper

### Description
This class combines the ordered dumping features of `OrderedDumperMixin` with the standard `yaml.Dumper`.

### Inheritance
- `OrderedDumperMixin`
- `yaml.Dumper`
```

--------------------------------

### Construct YAML Map with OrderedDict

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/loaders.html

This function constructs a mapping node, ensuring that if the Python version is 3.6 or lower, an OrderedDict is used to preserve key order. It yields the data structure and then updates it with the constructed mapping.

```python
def construct_yaml_map(self, node):
    if yamlloader.settings.PY_LE_36:
        data = OrderedDict()
    else:
        data = dict()
    yield data
    value = self.construct_mapping(node)
    data.update(value)
```

--------------------------------

### Dumper

Source: https://phynix.github.io/yamlloader/yamlloader.ordereddict.html

YAML dumper that preserves key order, using the standard PyYAML dumper.

```APIDOC
## Dumper

### Description
YAML dumper that preserves key order, using the standard PyYAML dumper.

### Class Signature
`yamlloader.ordereddict.Dumper(*args, **kwargs)`

### Inheritance
Bases: `yamlloader.ordereddict.dumpers.OrderedDumperMixin`, `yaml.dumper.Dumper`
```

--------------------------------

### SafeDumper

Source: https://phynix.github.io/yamlloader/yamlloader.ordereddict.html

Safe YAML dumper that preserves key order, using the standard PyYAML safe dumper.

```APIDOC
## SafeDumper

### Description
Safe YAML dumper that preserves key order, using the standard PyYAML safe dumper.

### Class Signature
`yamlloader.ordereddict.SafeDumper(*args, **kwargs)`

### Inheritance
Bases: `yamlloader.ordereddict.dumpers.OrderedDumperMixin`, `yaml.dumper.SafeDumper`
```

--------------------------------

### SafeDumper

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

A safe YAML dumper that inherits from OrderedDumperMixin and yaml.SafeDumper, providing ordered dumping capabilities for safe loading.

```APIDOC
## Class: SafeDumper

### Description
This class combines the ordered dumping features of `OrderedDumperMixin` with the `yaml.SafeDumper`, suitable for scenarios requiring safe YAML operations.

### Inheritance
- `OrderedDumperMixin`
- `yaml.SafeDumper`
```

--------------------------------

### OrderedDumperMixin for YAML Dumpers

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

Mixin class to add OrderedDict and dict (py37+) representation to PyYAML dumpers. It registers a custom representer to preserve order.

```python
class OrderedDumperMixin(object):
    def __init__(self, *args, **kwargs):
        sub_doc = self.__doc__
        if sub_doc is None:
            sub_doc = ""
        self.__doc__ = """Dump :py:class:~`collections.OrderedDict` and :py:class:`dict` (py37+) 
        to YAML preserving the order."""
        self.__doc__ += sub_doc
        super(OrderedDumperMixin, self).__init__(*args, **kwargs)
        self.add_representer(OrderedDict, type(self).represent_ordereddict)
        if not yamlloader.settings.PY_LE_36:
            self.add_representer(dict, type(self).represent_ordereddict)

    represent_ordereddict = staticmethod(represent_ordereddict)
```

--------------------------------

### Represent OrderedDict in YAML

Source: https://phynix.github.io/yamlloader/_modules/yamlloader/ordereddict/dumpers.html

Custom representer for OrderedDict to ensure order is maintained during YAML dumping. It maps OrderedDict items to a YAML sequence.

```python
def represent_ordereddict(self, data):
    """

    Parameters
    ----------
    data : dict, OrderedDict

    Returns
    -------
    mapping
    """
    return self.represent_mapping('tag:yaml.org,2002:map', data.items())
```
Tokens:
Raw