openlineage-python 0.30.1__tar.gz → 1.0.0__tar.gz

{openlineage_python-0.30.1 → openlineage_python-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openlineage-python
-Version: 0.30.1
+Version: 1.0.0
 Summary: OpenLineage Python Client
 Author-email: OpenLineage <info@openlineage.io>
 Keywords: openlineage
@@ -60,7 +60,7 @@ transport:
 ```
 
 The `type` property is required. It can be one of the built-in transports or a custom one.
-There are three built-in transports, `http`, `kafka` and `console`.
+There are four built-in transports, `http`, `kafka`, `console` and `file`.
 Custom transports `type` is a fully qualified class name that can be imported.
 
 The rest of the properties are defined by the particular transport.
@@ -85,6 +85,10 @@ You can also install `pip install openlineage-python[kafka]`
 * `topic` - required string parameter. The topic on what events will be sent.
 * `flush` - optional boolean parameter. If set to True, Kafka will flush after each event. By default true.
 
+#### File
+
+* `log_file_path` - required string parameter specifying the path of the file (if `append` is true a file path is expected, otherwise a file prefix is expected).
+* `append` - optional boolean parameter. If set to True, each event will be appended to a single file (log_file_path), otherwise, all event would be written separatly in distinct files suffixed by a timestring. By default false.
 
 ### Custom transport
 

{openlineage_python-0.30.1 → openlineage_python-1.0.0}/README.md

@@ -31,7 +31,7 @@ transport:
 ```
 
 The `type` property is required. It can be one of the built-in transports or a custom one.
-There are three built-in transports, `http`, `kafka` and `console`.
+There are four built-in transports, `http`, `kafka`, `console` and `file`.
 Custom transports `type` is a fully qualified class name that can be imported.
 
 The rest of the properties are defined by the particular transport.
@@ -56,6 +56,10 @@ You can also install `pip install openlineage-python[kafka]`
 * `topic` - required string parameter. The topic on what events will be sent.
 * `flush` - optional boolean parameter. If set to True, Kafka will flush after each event. By default true.
 
+#### File
+
+* `log_file_path` - required string parameter specifying the path of the file (if `append` is true a file path is expected, otherwise a file prefix is expected).
+* `append` - optional boolean parameter. If set to True, each event will be appended to a single file (log_file_path), otherwise, all event would be written separatly in distinct files suffixed by a timestring. By default false.
 
 ### Custom transport
 

{openlineage_python-0.30.1 → openlineage_python-1.0.0}/openlineage/client/client.py

@@ -59,10 +59,6 @@ class OpenLineageClient:
             # HTTP transport.
             if not options:
                 options = OpenLineageClientOptions()
-            if not session:
-                from requests import Session
-
-                session = Session()
             self._initialize_url(url, options, session)
         elif transport:
             self.transport = transport
@@ -81,7 +77,7 @@ class OpenLineageClient:
         self,
         url: str,
         options: OpenLineageClientOptions,
-        session: Session,
+        session: Session | None,
     ) -> None:
         self.transport = HttpTransport(
             HttpConfig.from_options(

{openlineage_python-0.30.1 → openlineage_python-1.0.0}/openlineage/client/constants.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 from __future__ import annotations
 
-__version__ = "0.30.1"
+__version__ = "1.0.0"
 
 DEFAULT_TIMEOUT_MS = 5000
 DEFAULT_NAMESPACE_NAME = "default"

{openlineage_python-0.30.1 → openlineage_python-1.0.0}/openlineage/client/transport/http.py

@@ -11,12 +11,13 @@ from urllib.parse import urljoin
 import attr
 
 if TYPE_CHECKING:
-    from requests import Session
     from requests.adapters import HTTPAdapter, Response
 
     from openlineage.client.client import OpenLineageClientOptions
     from openlineage.client.run import DatasetEvent, JobEvent, RunEvent
 
+from requests import Session
+
 from openlineage.client.serde import Serde
 from openlineage.client.transport.transport import Config, Transport
 from openlineage.client.utils import get_only_specified_fields, try_import_from_string
@@ -74,7 +75,7 @@ class HttpConfig(Config):
     verify: bool = attr.ib(default=True)
     auth: TokenProvider = attr.ib(factory=lambda: TokenProvider({}))
     # not set by TransportFactory
-    session: Session = attr.ib(factory=get_session)
+    session: Session | None = attr.ib(default=None)
     # not set by TransportFactory
     adapter: HTTPAdapter | None = attr.ib(default=None)
 
@@ -101,7 +102,7 @@ class HttpConfig(Config):
             auth=ApiKeyTokenProvider({"api_key": options.api_key})
             if options.api_key
             else TokenProvider({}),
-            session=session if session else get_session(),
+            session=session,
             adapter=options.adapter,
         )
 
@@ -112,8 +113,9 @@ class HttpTransport(Transport):
 
     def __init__(self, config: HttpConfig) -> None:
         url = config.url.strip()
+        self.config = config
 
-        log.debug("Constructing openlineage client to send events to %s", url)
+        log.debug("Constructing openlineage client to send events to %s - config %s", url, config)
         try:
             from urllib3.util import parse_url
 
@@ -127,30 +129,50 @@ class HttpTransport(Transport):
                 raise ValueError(msg)
         self.url = url
         self.endpoint = config.endpoint
-        self.session = config.session
-        self.session.headers["Content-Type"] = "application/json"
+        self.session = None
+        if config.session:
+            self.session = config.session
+            self.session.headers["Content-Type"] = "application/json"
+            auth_headers = self._auth_headers(config.auth)
+            self.session.headers.update(auth_headers)
         self.timeout = config.timeout
         self.verify = config.verify
 
-        self._add_auth(config.auth)
         if config.adapter:
             self.set_adapter(config.adapter)
 
     def set_adapter(self, adapter: HTTPAdapter) -> None:
-        self.session.mount(self.url, adapter)
+        if self.session:
+            self.session.mount(self.url, adapter)
 
     def emit(self, event: Union[RunEvent, DatasetEvent, JobEvent]) -> Response:  # noqa: UP007
         event_str = Serde.to_json(event)
-        resp = self.session.post(
-            urljoin(self.url, self.endpoint),
-            event_str,
-            timeout=self.timeout,
-            verify=self.verify,
-        )
+        if self.session:
+            resp = self.session.post(
+                urljoin(self.url, self.endpoint),
+                event_str,
+                timeout=self.timeout,
+                verify=self.verify,
+            )
+        else:
+            headers = {
+                "Content-Type": "application/json",
+            }
+            headers.update(self._auth_headers(self.config.auth))
+            with Session() as session:
+                resp = session.post(
+                    urljoin(self.url, self.endpoint),
+                    event_str,
+                    headers=headers,
+                    timeout=self.timeout,
+                    verify=self.verify,
+                )
+            resp.close()
         resp.raise_for_status()
         return resp
 
-    def _add_auth(self, token_provider: TokenProvider) -> None:
+    def _auth_headers(self, token_provider: TokenProvider) -> dict:  # type: ignore[type-arg]
         bearer = token_provider.get_bearer()
         if bearer:
-            self.session.headers.update({"Authorization": bearer})
+            return {"Authorization": bearer}
+        return {}

{openlineage_python-0.30.1 → openlineage_python-1.0.0}/pyproject.toml

@@ -6,7 +6,7 @@ requires = [
 
 [project]
 name = "openlineage-python"
-version = "0.30.1"
+version = "1.0.0"
 description = "OpenLineage Python Client"
 readme = "README.md"
 keywords = [

{openlineage_python-0.30.1 → openlineage_python-1.0.0}/tests/test_http.py

@@ -35,7 +35,7 @@ def test_http_loads_full_config() -> None:
     assert config.endpoint == "api/v1/lineage"
     assert config.verify is False
     assert config.auth.api_key == "1500100900"
-    assert isinstance(config.session, Session)
+    assert config.session is None
     assert config.adapter is None
 
 
@@ -49,7 +49,7 @@ def test_http_loads_minimal_config() -> None:
     assert config.url == "http://backend:5000/api/v1/lineage"
     assert config.verify is True
     assert not hasattr(config.auth, "api_key")
-    assert isinstance(config.session, Session)
+    assert config.session is None
     assert config.adapter is None
 
 
@@ -111,3 +111,13 @@ def test_client_with_http_transport_emits_custom_endpoint(mocker: MockerFixture)
         timeout=5.0,
         verify=True,
     )
+
+
+def test_http_config_configs_session() -> None:
+    with Session() as s:
+        config = HttpConfig(url="http://backend:5000/api/v1/lineage", session=s)
+        assert config.url == "http://backend:5000/api/v1/lineage"
+        assert config.verify is True
+        assert not hasattr(config.auth, "api_key")
+        assert config.session is s
+        assert config.adapter is None

{openlineage_python-0.30.1 → openlineage_python-1.0.0}/tox.ini

@@ -8,7 +8,6 @@ env_list =
     py39
     py38
     type
-    fix
 skip_missing_interpreters = true
 
 [testenv]
@@ -44,14 +43,6 @@ set_env =
 commands =
     mypy --namespace-packages --explicit-package-bases openlineage
 
-[testenv:fix]
-description = run static analysis and style check using flake8
-skip_install = true
-deps =
-    pre-commit>=3.3.2
-commands =
-    pre-commit run --all-files --show-diff-on-failure
-
 [testenv:dev]
 description = generate a DEV environment
 package = editable