Skip to content

Option --config - file operation

Here focus on a small part --- a feature of one specific option --config under sub-command run.

UML

  • Object MockHTTPServer uses function load_config to get all detail settings.
  • Data object APIConfig provides function to read and deserialize the configuration file content.
  • Currently, it only supports parsing YAML file by object YAML.

Extension

Here demonstrate how to extend this feature to parse other file formatter.

  • File operation

If you want to use other file formatter, e.g., JSON, you could extend the base class of file operation _BaseFileOperation to implement needed features.

fake_api_server._utils.file.operation
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# ... some code

class JSON(_BaseFileOperation):
    def read(self):
        # Read the configuration file content

    def write(self, path: str, config: Union[str, dict]) -> None:
        # Write data into file

    def serialize(self, config: dict) -> str:
        # Serialize dat object to string value

Because currently it won't have option in command line to control which way it should use to serialize or deserialize configuration file, so we need to manually modify the code to use it.

fake_api_server.model.api_config.__init__
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from fake_api_server._utils.file.operation import JSON

# ... some code ...

class FakeAPIConfig(_Config, _Checkable):
    """*The entire configuration*"""

    _name: str = ""
    _description: str = ""
    _apis: Optional[MockAPIs]

    # ... some code ...

    _configuration: _BaseFileOperation = JSON()

    # ... some code ...

    def __init__(self, name: str = "", description: str = "", apis: Optional[MockAPIs] = None):
        self._name = name
        # ... some code

Finally, we could use JSON type file as our configuration formatter.

>>> fake rest-server run -c ./api.json