Skip to content

Use rest_api_resources in generated sources #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Mirochill wants to merge 1 commit into
base: devel
Choose a base branch
from
Draft

Use rest_api_resources in generated sources #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions dlt_init_openapi/renderer/default/templates/source.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
from typing import List
from typing import Iterable

import dlt
from dlt.extract.source import DltResource

from dlt.sources.rest_api.typing import RESTAPIConfig
from dlt.sources.rest_api import rest_api_source
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources


@dlt.source(name="{{source_name}}", max_table_nesting=2)
Expand All @@ -15,7 +14,7 @@ def {{ source_name }}(
{% endfor %}
{% endif %}
base_url: str = dlt.config.value,
) -> List[DltResource]:
) -> Iterable[DltResource]:

# source configuration
source_config: RESTAPIConfig = {
Expand Down Expand Up @@ -107,5 +106,4 @@ def {{ source_name }}(
]
}

return rest_api_source(source_config)

yield from rest_api_resources(source_config)
16 changes: 15 additions & 1 deletion tests/integration/basics/test_misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from dlt_init_openapi.config import Config
from tests.integration.utils import get_indexed_resources
from tests.cases import case_path
from tests.integration.utils import get_detected_project_from_open_api, get_indexed_resources


def test_endpoint_selection() -> None:
Expand All @@ -19,3 +20,16 @@ def test_endpoint_selection() -> None:
)
assert len(filtered_resources.keys()) == 2
assert list(filtered_resources.keys()) == [base_keys[0], base_keys[3]]


def test_source_template_yields_rest_api_resources() -> None:
project = get_detected_project_from_open_api(
case_path("artificial", "pagination.yml"),
config=Config(name_resources_by_operation=True),
)
project.render(dry=True)
source = project.renderer._render_source() # type: ignore

assert "from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources" in source
assert "yield from rest_api_resources(source_config)" in source
assert "rest_api_source(" not in source
2 changes: 1 addition & 1 deletion tests/integration/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def get_source_or_dict_from_open_api(

if rt == "dict":
source = source.replace('@dlt.source(name="test_source", max_table_nesting=2)', "")
source = source.replace("rest_api_source(source_config)", "source_config")
source = source.replace("yield from rest_api_resources(source_config)", "return source_config")
source = source.replace("dlt.secrets.value", '"SECRET_VALUE"')

# The template now correctly uses dlt.sources.rest_api imports
Expand Down