relationalai 0.13.0.dev0__py3-none-any.whl → 0.13.1__py3-none-any.whl

relationalai-0.13.1.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024, RelationalAI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

relationalai_test_util/__init__.py

@@ -0,0 +1,4 @@
+from . import snapshot
+from . import traceback
+from . import fixtures
+__all__ = ["snapshot", "traceback", "fixtures"]

relationalai_test_util/fixtures.py

@@ -0,0 +1,233 @@
+from __future__ import annotations
+import random
+import os
+from typing import Optional
+
+import snowflake.connector
+
+import relationalai as rai
+from relationalai import debugging
+from relationalai.debugging import logger
+from relationalai.clients import config as cfg
+from relationalai.util.otel_handler import enable_otel_export
+from relationalai.tools.constants import USE_PACKAGE_MANAGER
+from relationalai.util.snowflake_handler import SnowflakeHandler
+from relationalai.util.span_format_test import SpanCollectorHandler, assert_valid_span_structure
+from relationalai.util.span_tracker import TRACE_ID, get_root_span_attrs
+
+def graph_index_config_fixture():
+    cloud_provider = os.getenv("RAI_CLOUD_PROVIDER")
+    if cloud_provider:
+        config = make_config()
+    else:
+        config = cfg.Config()
+
+    config.set("use_graph_index", True)
+    config.set("reuse_model", False)
+
+    yield config
+    return
+
+def engine_config_fixture(size, use_direct_access=False, reset_session=False, query_timeout_mins=None, generation=rai.Generation.V0):
+    # Check for an externally provided engine name
+    # It is used in GitHub Actions to run tests against a specific engine
+    engine_name = os.getenv("ENGINE_NAME")
+    if engine_name:
+        # If engine name was provided, just yield the config
+        config = make_config(engine_name, use_direct_access=use_direct_access)
+        # Try to reset the session instead of using active session if reset_session is true
+        rai.Resources(config=config, reset_session=reset_session)
+
+        if os.getenv("DISABLE_PROFILE_POLLING"):
+            print('disabling `debug` in config')
+            config.set("debug", False)
+
+        config.set("reuse_model", False)
+        config.set("enable_otel_handler", True) 
+        if query_timeout_mins is not None:
+            config.set("query_timeout_mins", query_timeout_mins)
+
+        yield config
+        return
+
+    # If there's a local config file, use it, including
+    # the engine specified there.
+    config = cfg.Config()
+    if config.file_path is not None:
+        # Set test defaults
+        config.set("reuse_model", False)
+        if query_timeout_mins is not None:
+            config.set("query_timeout_mins", query_timeout_mins)
+        # Try to reset the session instead of using active session if reset_session is true
+        rai.Resources(config=config, reset_session=reset_session, generation=generation)
+        yield config
+        return
+
+    # Otherwise, create a new engine and delete it afterwards.
+    random_number = random.randint(1000000000, 9999999999)
+    engine_name = f"pyrel_test_{random_number}"
+    create_engine(engine_name, size=size, use_direct_access=use_direct_access)
+
+    yield make_config(engine_name, use_direct_access=use_direct_access)
+
+    delete_engine(engine_name, use_direct_access=use_direct_access)
+
+def create_engine(engine_name: str, size: str,  use_direct_access=False):
+    print('create_engine: about to call make_config')
+    config = make_config(engine_name, use_direct_access=use_direct_access)
+
+    provider = rai.Resources(config=config)
+    print(f"Creating engine {engine_name}")
+    provider.create_engine(name=engine_name, size=size)
+    print(f"Engine {engine_name} created")
+
+def delete_engine(engine_name: str, use_direct_access=False):
+    print(f"Deleting engine {engine_name}")
+    config = make_config(engine_name, use_direct_access=use_direct_access)
+    provider = rai.Resources(config=config)
+    provider.delete_engine(engine_name)
+    print(f"Engine {engine_name} deleted")
+
+def make_config(engine_name: str | None = None, fetch_profile: bool = True, use_package_manager = USE_PACKAGE_MANAGER, use_direct_access = False, show_full_traces = True, show_debug_logs = True, reuse_model = False) -> cfg.Config:
+    # First try to load from raiconfig.toml
+    try:
+        config = cfg.Config()
+        if config.file_path is not None:
+            # Set test defaults
+            config.set("reuse_model", reuse_model)
+            rai.Resources(config=config)
+            return config
+    except Exception as e:
+        print(f"Could not load config from file: {e}, trying environment variables")
+    # If that fails, construct from environment variables
+    cloud_provider = os.getenv("RAI_CLOUD_PROVIDER")
+
+    if cloud_provider is None:
+        cloud_provider = os.getenv("RAI_CLOUD_PROVIDER")
+
+    print('cloud provider:', cloud_provider)
+
+    if cloud_provider is None:
+        raise ValueError("RAI_CLOUD_PROVIDER must be set")
+    elif cloud_provider == "azure":
+        client_id = os.getenv("RAI_CLIENT_ID")
+        client_secret = os.getenv("RAI_CLIENT_SECRET")
+        if client_id is None or client_secret is None:
+            raise ValueError(
+                "RAI_CLIENT_ID, RAI_CLIENT_SECRET must be set if RAI_CLOUD_PROVIDER is set to 'azure'"
+            )
+
+        # Pull from env vars; Default to prod
+        host = os.getenv("RAI_AZURE_HOST") or "azure.relationalai.com"
+        creds_url = os.getenv("RAI_AZURE_CLIENT_CREDENTIALS_URL") or "https://login.relationalai.com/oauth/token"
+        region = os.getenv("RAI_AZURE_REGION") or "us-east"
+
+        return cfg.Config(
+
+            {
+                "platform": "azure",
+                "host": host,
+                "port": "443",
+                "region": region,
+                "scheme": "https",
+                "client_credentials_url": creds_url,
+                "client_id": client_id,
+                "client_secret": client_secret,
+                "engine": engine_name,
+                "use_package_manager": use_package_manager,
+                "show_full_traces": show_full_traces,
+                "show_debug_logs": show_debug_logs,
+                "reuse_model": reuse_model,
+            }
+        )
+
+    elif cloud_provider == "snowflake":
+        sf_username = os.getenv("SF_TEST_ACCOUNT_USERNAME")
+        sf_password = os.getenv("SF_TEST_ACCOUNT_PASSWORD")
+        sf_account = os.getenv("SF_TEST_ACCOUNT_NAME")
+        sf_role = os.getenv("SF_TEST_ROLE_NAME", "RAI_USER")
+        sf_warehouse = os.getenv("SF_TEST_WAREHOUSE_NAME")
+        sf_app_name = os.getenv("SF_TEST_APP_NAME")
+        if sf_username is None or sf_password is None:
+            raise ValueError(
+                "SF_TEST_ACCOUNT_USERNAME, SF_TEST_ACCOUNT_PASSWORD, SF_TEST_ACCOUNT_NAME must be set if RAI_CLOUD_PROVIDER is set to 'snowflake'"
+            )
+
+        current_config = {
+            "platform": "snowflake",
+            "user": sf_username,
+            "password": sf_password,
+            "account": sf_account,
+            "role": sf_role,
+            "warehouse": sf_warehouse,
+            "rai_app_name": sf_app_name,
+            "use_package_manager": use_package_manager,
+            "use_direct_access": use_direct_access,
+            "show_full_traces": show_full_traces,
+            "show_debug_logs": show_debug_logs,
+            "reuse_model": reuse_model,
+        }
+        if engine_name:
+            current_config["engine"] = engine_name
+
+        # For direct access, we use key-pair as the default for testing and need to configure additional parameters.
+        if use_direct_access:
+            authenticator=os.getenv("AUTHENTICATOR","")
+            private_key_file=os.getenv("PRIVATE_KEY_FILE","")
+            private_key_file_pwd=os.getenv("SF_TEST_ACCOUNT_KEY_PASSPHRASE","")
+
+            current_config["authenticator"] = authenticator
+            current_config["private_key_file"] = private_key_file
+            current_config["private_key_file_pwd"]=private_key_file_pwd
+
+        return cfg.Config(current_config, fetch=fetch_profile)
+
+    else:
+        raise ValueError(f"Unsupported cloud provider: {cloud_provider}")
+
+def snowflake_handler_fixture():
+    if not os.getenv("SF_REPORTING_PASSWORD"):
+        print('snowflake logger disabled since required config env vars not present')
+        yield
+        return
+
+    conn = snowflake.connector.connect(
+        user=os.getenv("SF_REPORTING_USER"),
+        password=os.getenv("SF_REPORTING_PASSWORD"),
+        account=os.getenv("SF_REPORTING_ACCOUNT"),
+        role=os.getenv("SF_REPORTING_ROLE"),
+        warehouse=os.getenv("SF_REPORTING_WAREHOUSE"),
+        database=os.getenv("SF_REPORTING_DATABASE"),
+        schema=os.getenv("SF_REPORTING_SCHEMA"),
+    )
+    snowflake_handler = SnowflakeHandler(TRACE_ID, conn)
+    logger.addHandler(snowflake_handler)
+    yield
+    snowflake_handler.shut_down()
+
+def span_structure_validator_fixture():
+    handler = SpanCollectorHandler()
+    logger.addHandler(handler)
+    yield handler
+    logger.removeHandler(handler)
+    # We skip tests in certain environments, so there's no need to perform span checks when those tests aren't executed.
+    if os.getenv("SkipSpanValidation") != str(True):
+        assert_valid_span_structure(handler.nodes, handler.events)
+
+def root_span_fixture(get_full_config=False, span_type: str = "test_session", extra_attrs: Optional[dict] = None):
+    root_span_attrs = get_root_span_attrs(get_full_config)
+    if extra_attrs:
+        root_span_attrs.update(extra_attrs)
+    with debugging.span(span_type, **root_span_attrs):
+        yield
+
+def otel_collector_fixture(generation):
+    config = make_config()
+    from relationalai.clients.resources.snowflake import Resources
+    resources = Resources(config=config, generation=generation)
+    enable_otel_export(
+        resources,
+        config.get('rai_app_name', 'RELATIONALAI')
+    )
+
+    yield