forked from openapi-generators/openapi-python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path__init__.py
More file actions
219 lines (172 loc) · 8.04 KB
/
__init__.py
File metadata and controls
219 lines (172 loc) · 8.04 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
""" Generate modern Python clients from OpenAPI """
from __future__ import annotations
import json
import shutil
import subprocess
import sys
from pathlib import Path
from typing import Any, Dict, Optional
import httpx
import yaml
from jinja2 import Environment, PackageLoader
from openapi_python_client import utils
from .openapi_parser import OpenAPI, import_string_from_reference
from .openapi_parser.errors import MultipleParseError
if sys.version_info.minor == 7: # version did not exist in 3.7, need to use a backport
from importlib_metadata import version # type: ignore
else:
from importlib.metadata import version # type: ignore
__version__ = version(__package__)
def _get_project_for_url_or_path(url: Optional[str], path: Optional[Path]) -> _Project:
data_dict = _get_json(url=url, path=path)
openapi = OpenAPI.from_dict(data_dict)
return _Project(openapi=openapi)
def load_config(*, path: Path) -> None:
""" Loads config from provided Path """
config_data = yaml.safe_load(path.read_text())
if "class_overrides" in config_data:
from .openapi_parser import reference
for class_name, class_data in config_data["class_overrides"].items():
reference.class_overrides[class_name] = reference.Reference(**class_data)
def create_new_client(*, url: Optional[str], path: Optional[Path]) -> None:
""" Generate the client library """
project = _get_project_for_url_or_path(url=url, path=path)
project.build()
def update_existing_client(*, url: Optional[str], path: Optional[Path]) -> None:
""" Update an existing client library """
project = _get_project_for_url_or_path(url=url, path=path)
project.update()
def _get_json(*, url: Optional[str], path: Optional[Path]) -> Dict[str, Any]:
json_bytes: bytes
if url is not None and path is not None:
raise ValueError("Provide URL or Path, not both.")
elif url is not None:
response = httpx.get(url)
json_bytes = response.content
elif path is not None:
json_bytes = path.read_bytes()
else:
raise ValueError("No URL or Path provided")
return json.loads(json_bytes)
class _Project:
TEMPLATE_FILTERS = {"snakecase": utils.snake_case}
def __init__(self, *, openapi: OpenAPI) -> None:
self.openapi: OpenAPI = openapi
self.env: Environment = Environment(loader=PackageLoader(__package__), trim_blocks=True, lstrip_blocks=True)
self.project_name: str = f"{openapi.title.replace(' ', '-').lower()}-client"
self.project_dir: Path = Path.cwd() / self.project_name
self.package_name: str = self.project_name.replace("-", "_")
self.package_dir: Path = self.project_dir / self.package_name
self.package_description = f"A client library for accessing {self.openapi.title}"
self.env.filters.update(self.TEMPLATE_FILTERS)
def build(self) -> None:
""" Create the project from templates """
print(f"Generating {self.project_name}")
self.project_dir.mkdir()
self._create_package()
self._build_metadata()
self._build_models()
self._build_api()
self._reformat()
self._raise_errors()
def update(self) -> None:
""" Update an existing project """
if not self.package_dir.is_dir():
raise FileNotFoundError()
print(f"Updating {self.project_name}")
shutil.rmtree(self.package_dir)
self._create_package()
self._build_models()
self._build_api()
self._reformat()
self._raise_errors()
def _reformat(self) -> None:
subprocess.run(
"isort --recursive --apply",
cwd=self.project_dir,
shell=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
subprocess.run("black .", cwd=self.project_dir, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
def _raise_errors(self) -> None:
errors = []
for collection in self.openapi.endpoint_collections_by_tag.values():
errors.extend(collection.parse_errors)
if errors:
raise MultipleParseError(parse_errors=errors)
def _create_package(self) -> None:
self.package_dir.mkdir()
# Package __init__.py
package_init = self.package_dir / "__init__.py"
package_init_template = self.env.get_template("package_init.pyi")
package_init.write_text(package_init_template.render(description=self.package_description))
pytyped = self.package_dir / "py.typed"
pytyped.write_text("# Marker file for PEP 561")
def _build_metadata(self) -> None:
# Create a pyproject.toml file
pyproject_template = self.env.get_template("pyproject.toml")
pyproject_path = self.project_dir / "pyproject.toml"
pyproject_path.write_text(
pyproject_template.render(
project_name=self.project_name, package_name=self.package_name, description=self.package_description
)
)
# README.md
readme = self.project_dir / "README.md"
readme_template = self.env.get_template("README.md")
readme.write_text(
readme_template.render(
project_name=self.project_name, description=self.package_description, package_name=self.package_name
)
)
# .gitignore
git_ignore_path = self.project_dir / ".gitignore"
git_ignore_template = self.env.get_template(".gitignore")
git_ignore_path.write_text(git_ignore_template.render())
def _build_models(self) -> None:
# Generate models
models_dir = self.package_dir / "models"
models_dir.mkdir()
models_init = models_dir / "__init__.py"
imports = []
types_template = self.env.get_template("types.py")
types_path = models_dir / "types.py"
types_path.write_text(types_template.render())
model_template = self.env.get_template("model.pyi")
for schema in self.openapi.schemas.values():
module_path = models_dir / f"{schema.reference.module_name}.py"
module_path.write_text(model_template.render(schema=schema))
imports.append(import_string_from_reference(schema.reference))
# Generate enums
enum_template = self.env.get_template("enum.pyi")
for enum in self.openapi.enums.values():
module_path = models_dir / f"{enum.reference.module_name}.py"
module_path.write_text(enum_template.render(enum=enum))
imports.append(import_string_from_reference(enum.reference))
models_init_template = self.env.get_template("models_init.pyi")
models_init.write_text(models_init_template.render(imports=imports))
def _build_api(self) -> None:
# Generate Client
client_path = self.package_dir / "client.py"
client_template = self.env.get_template("client.pyi")
client_path.write_text(client_template.render())
# Generate endpoints
api_dir = self.package_dir / "api"
api_dir.mkdir()
api_init = api_dir / "__init__.py"
api_init.write_text('""" Contains synchronous methods for accessing the API """')
async_api_dir = self.package_dir / "async_api"
async_api_dir.mkdir()
async_api_init = async_api_dir / "__init__.py"
async_api_init.write_text('""" Contains async methods for accessing the API """')
api_errors = self.package_dir / "errors.py"
errors_template = self.env.get_template("errors.pyi")
api_errors.write_text(errors_template.render())
endpoint_template = self.env.get_template("endpoint_module.pyi")
async_endpoint_template = self.env.get_template("async_endpoint_module.pyi")
for tag, collection in self.openapi.endpoint_collections_by_tag.items():
module_path = api_dir / f"{tag}.py"
module_path.write_text(endpoint_template.render(collection=collection))
async_module_path = async_api_dir / f"{tag}.py"
async_module_path.write_text(async_endpoint_template.render(collection=collection))