alihan/datamodel-code-generator
1
0
Fork 0
mirror of https://github.com/koxudaxi/datamodel-code-generator.git synced 2024-03-18 14:54:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

Change --validation option to optional (#1675)

Browse Source 
* Change --validation option to optional

* Fix deps

* Fix deps

* Fix coverage
This commit is contained in:
Koudai Aono
2023-11-10 01:56:20 +09:00
committed by GitHub
parent 7d53b9892e
commit cbbe26da46
9 changed files with 52 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -443,7 +443,9 @@ OpenAPI-only options:
OpenAPI)
--use-operation-id-as-name
use operation id of OpenAPI as class names of models
--validation Enable validation (Only OpenAPI)
--validation Deprecated: Enable validation (Only OpenAPI). this
option is deprecated. it will be removed in future
releases
General options:
--debug show debug message (require "debug". `$ pip install 'datamodel-code-generator[debug]'`)

2
datamodel_code_generator/__init__.py
View File

@@ -79,7 +79,7 @@ else:
def enable_debug_message() -> None: # pragma: no cover
if not pysnooper:
raise Exception(
"Please run $pip install 'datamodel-code-generator[debug]' to use debug option"
"Please run `$pip install 'datamodel-code-generator[debug]'` to use debug option"
)
pysnooper.tracer.DISABLED = False

3
datamodel_code_generator/arguments.py
View File

@@ -410,7 +410,8 @@ openapi_options.add_argument(
)
openapi_options.add_argument(
'--validation',
help='Enable validation (Only OpenAPI)',
help='Deprecated: Enable validation (Only OpenAPI). this option is deprecated. it will be removed in future '
'releases',
action='store_true',
default=None,
)

2
datamodel_code_generator/http.py
View File

@@ -6,7 +6,7 @@ try:
import httpx
except ImportError: # pragma: no cover
raise Exception(
"Please run $pip install 'datamodel-code-generator[http]' to resolve URL Reference"
"Please run `$pip install 'datamodel-code-generator[http]`' to resolve URL Reference"
)

27
datamodel_code_generator/parser/openapi.py
View File

@@ -23,6 +23,7 @@ from typing import (
Union,
)
from urllib.parse import ParseResult
from warnings import warn
from pydantic import Field
@@ -550,13 +551,27 @@ class OpenAPIParser(JsonSchemaParser):
def parse_raw(self) -> None:
for source, path_parts in self._get_context_source_path_parts():
if self.validation:
from prance import BaseParser
BaseParser(
spec_string=source.text,
backend='openapi-spec-validator',
encoding=self.encoding,
warn(
'Deprecated: `--validation` option is deprecated. the option will be removed in a future '
'release. please use another tool to validate OpenAPI.\n'
)
try:
from prance import BaseParser
BaseParser(
spec_string=source.text,
backend='openapi-spec-validator',
encoding=self.encoding,
)
except ImportError: # pragma: no cover
warn(
"Warning: Validation was skipped for OpenAPI. `prance` or `openapi-spec-validator` are not "
"installed.\n"
"To use --validation option after datamodel-code-generator 0.24.0, Please run `$pip install "
"'datamodel-code-generator[validation]'`.\n"
)
specification: Dict[str, Any] = load_yaml(source.text)
self.raw_obj = specification
schemas: Dict[Any, Any] = specification.get('components', {}).get(

4
docs/index.md
View File

@@ -440,7 +440,9 @@ OpenAPI-only options:
OpenAPI)
--use-operation-id-as-name
use operation id of OpenAPI as class names of models
--validation Enable validation (Only OpenAPI)
--validation Deprecated: Enable validation (Only OpenAPI). this
option is deprecated. it will be removed in future
releases
General options:
--debug show debug message (require "debug". `$ pip install 'datamodel-code-generator[debug]'`)

3
poetry.lock generated
View File

@@ -1663,8 +1663,9 @@ testing = ["flake8 (<5)", "func-timeout", "jaraco.functools", "jaraco.itertools"
[extras]
debug = ["PySnooper"]
http = ["httpx"]
validation = ["openapi-spec-validator", "prance"]
[metadata]
lock-version = "2.0"
python-versions = "^3.7"
content-hash = "a80ca8adc2c59d0b7c127b468c9190d34fb68b747e004c9f1f30798fa70de6d2"
content-hash = "3e92c6177b16601bf25bbcdd7a7292fe9e7a8102051cc70acb9e2e7726377cef"

13
pyproject.toml
View File

@@ -49,17 +49,17 @@ pydantic = [
{extras = ["email"], version = ">=1.10.0,!=2.0.0,!=2.0.1,<3.0,!=2.4.0", python = "^3.12"}
]
argcomplete = ">=1.10,<4.0"
prance = ">=0.18.2"
openapi-spec-validator = ">=0.2.8,<0.7.0"
jinja2 = ">=2.10.1,<4.0"
inflect = ">=4.1.0,<6.0"
black = ">=19.10b0"
isort = ">=4.3.21,<6.0"
PySnooper = { version = ">=0.4.1,<2.0.0", optional = true }
toml = { version = ">=0.10.0,<1.0.0", python = "<3.11" }
genson = ">=1.2.1,<2.0"
httpx = { version = "*", optional = true }
packaging = "*"
prance = { version = ">=0.18.2", optional = true }
openapi-spec-validator = { version = ">=0.2.8,<0.7.0", optional = true }
toml = { version = ">=0.10.0,<1.0.0", python = "<3.11" }
PySnooper = { version = ">=0.4.1,<2.0.0", optional = true }
httpx = { version = "*", optional = true }
[tool.poetry.group.dev.dependencies]
pytest = ">6.0"
@@ -80,10 +80,13 @@ ruff = ">=0.0.290,<0.1.6"
ruff-lsp = ">=0.0.39,<0.0.41"
pre-commit = "*"
pytest-xdist = "^3.3.1"
prance = "*"
openapi-spec-validator = "*"
[tool.poetry.extras]
http = ["httpx"]
debug = ["PySnooper"]
validation = ["prance", "openapi-spec-validator"]
[tool.ruff]
line-length = 88

14
tests/test_main.py
View File

@@ -801,7 +801,9 @@ def test_show_help_when_no_input(mocker):
@freeze_time('2019-07-26')
def test_validation():
def test_validation(mocker):
mock_prance = mocker.patch('prance.BaseParser')
with TemporaryDirectory() as output_dir:
output_file: Path = Path(output_dir) / 'output.py'
return_code: Exit = main(
@@ -818,10 +820,12 @@ def test_validation():
output_file.read_text()
== (EXPECTED_MAIN_PATH / 'validation' / 'output.py').read_text()
)
mock_prance.assert_called_once()
@freeze_time('2019-07-26')
def test_validation_failed():
def test_validation_failed(mocker):
mock_prance = mocker.patch('prance.BaseParser', side_effect=Exception('error'))
with TemporaryDirectory() as output_dir:
output_file: Path = Path(output_dir) / 'output.py'
assert (
@@ -838,6 +842,7 @@ def test_validation_failed():
)
== Exit.ERROR
)
mock_prance.assert_called_once()
@pytest.mark.parametrize(
@@ -4238,7 +4243,9 @@ def test_main_jsonschema_has_default_value():
@freeze_time('2019-07-26')
def test_openapi_special_yaml_keywords():
def test_openapi_special_yaml_keywords(mocker):
mock_prance = mocker.patch('prance.BaseParser')
with TemporaryDirectory() as output_dir:
output_file: Path = Path(output_dir) / 'output.py'
return_code: Exit = main(
@@ -4257,6 +4264,7 @@ def test_openapi_special_yaml_keywords():
EXPECTED_MAIN_PATH / 'main_special_yaml_keywords' / 'output.py'
).read_text()
)
mock_prance.assert_called_once()
@freeze_time('2019-07-26')