Skip to content

# Json base

The tool to check the availability or syntax of domain, IP or URL.

::

    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides a base for the manipulation of JSON files.

Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks: https://pyfunceble.github.io/#/special-thanks

Contributors: https://pyfunceble.github.io/#/contributors

Project link: https://github.com/funilrys/PyFunceble

Project documentation: https://docs.pyfunceble.com

Project homepage: https://pyfunceble.github.io/

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 Nissar Chababy

    Licensed 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

        https://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.

## `FilesystemJSONBase`

Bases: `FilesystemDirBase`

A base interface for the manipulation of JSON files.

Source code in `PyFunceble/cli/filesystem/json_base.py`

     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139

    class FilesystemJSONBase(FilesystemDirBase):
        """
        A base interface for the manipulation of JSON files.
        """

        dataset: Dict[str, int] = {}
        source_file_path: Optional[str] = None

        SOURCE_FILE: Optional[str] = None
        STD_DATASET: Union[dict, list] = {}

        def update_source_file_path_beforehand(func):  # pylint: disable=no-self-argument
            """
            Updates the source file before launching the decorated method.
            """

            @functools.wraps(func)
            def wrapper(self, *args, **kwargs):
                self.source_file_path = os.path.join(
                    self.get_output_basedir(), self.SOURCE_FILE
                )

                return func(self, *args, **kwargs)  # pylint: disable=not-callable

            return wrapper

        def fetch_dataset_beforehand(func):  # pylint: disable=no-self-argument
            """
            Updates the dataset to work with before launching the decorated method.
            """

            @functools.wraps(func)
            def wrapper(self, *args, **kwargs):
                self.fetch_dataset()

                return func(self, *args, **kwargs)  # pylint: disable=not-callable

            return wrapper

        def save_dataset_afterwards(func):  # pylint: disable=no-self-argument
            """
            Saves the dataset after launching the decorated method.
            """

            @functools.wraps(func)
            def wrapper(self, *args, **kwargs):
                result = func(self, *args, **kwargs)  # pylint: disable=not-callable

                self.save_dataset()

                return result

            return wrapper

        @update_source_file_path_beforehand
        def fetch_dataset(self) -> "FilesystemJSONBase":
            """
            Fetch the dataset from the source file.
            """

            file_helper = FileHelper(self.source_file_path)

            if file_helper.exists():
                self.dataset = DictHelper().from_json_file(file_helper.path)
            else:
                self.dataset = copy.deepcopy(self.STD_DATASET)

            return self

        def save_dataset(self) -> "FilesystemJSONBase":
            """
            Saves the current dataset into it's final destination.
            """

            DictHelper(self.dataset).to_json_file(self.source_file_path)

            return self

### `fetch_dataset()`

Fetch the dataset from the source file.

Source code in `PyFunceble/cli/filesystem/json_base.py`

    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130

    @update_source_file_path_beforehand
    def fetch_dataset(self) -> "FilesystemJSONBase":
        """
        Fetch the dataset from the source file.
        """

        file_helper = FileHelper(self.source_file_path)

        if file_helper.exists():
            self.dataset = DictHelper().from_json_file(file_helper.path)
        else:
            self.dataset = copy.deepcopy(self.STD_DATASET)

        return self

### `fetch_dataset_beforehand(func)`

Updates the dataset to work with before launching the decorated method.

Source code in `PyFunceble/cli/filesystem/json_base.py`

     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100

    def fetch_dataset_beforehand(func):  # pylint: disable=no-self-argument
        """
        Updates the dataset to work with before launching the decorated method.
        """

        @functools.wraps(func)
        def wrapper(self, *args, **kwargs):
            self.fetch_dataset()

            return func(self, *args, **kwargs)  # pylint: disable=not-callable

        return wrapper

### `save_dataset()`

Saves the current dataset into it's final destination.

Source code in `PyFunceble/cli/filesystem/json_base.py`

    132
    133
    134
    135
    136
    137
    138
    139

    def save_dataset(self) -> "FilesystemJSONBase":
        """
        Saves the current dataset into it's final destination.
        """

        DictHelper(self.dataset).to_json_file(self.source_file_path)

        return self

### `save_dataset_afterwards(func)`

Saves the dataset after launching the decorated method.

Source code in `PyFunceble/cli/filesystem/json_base.py`

    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115

    def save_dataset_afterwards(func):  # pylint: disable=no-self-argument
        """
        Saves the dataset after launching the decorated method.
        """

        @functools.wraps(func)
        def wrapper(self, *args, **kwargs):
            result = func(self, *args, **kwargs)  # pylint: disable=not-callable

            self.save_dataset()

            return result

        return wrapper

### `update_source_file_path_beforehand(func)`

Updates the source file before launching the decorated method.

Source code in `PyFunceble/cli/filesystem/json_base.py`

    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87

    def update_source_file_path_beforehand(func):  # pylint: disable=no-self-argument
        """
        Updates the source file before launching the decorated method.
        """

        @functools.wraps(func)
        def wrapper(self, *args, **kwargs):
            self.source_file_path = os.path.join(
                self.get_output_basedir(), self.SOURCE_FILE
            )

            return func(self, *args, **kwargs)  # pylint: disable=not-callable

        return wrapper