SNOW-582911 added parameter files (#288)

Author: sfc-gh-mkeller

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -33,7 +33,7 @@ Please answer these questions before submitting your issue. Thanks!
    import logging
    import os
 
-   for logger_name in ['snowflake.sqlalchemy', 'snowflake.connector']: 
+   for logger_name in ['snowflake.sqlalchemy', 'snowflake.connector']:
       logger = logging.getLogger(logger_name)
       logger.setLevel(logging.DEBUG)
       ch = logging.StreamHandler()

.github/workflows/build_test.yml

@@ -0,0 +1,144 @@
+name: Build and Test
+
+on:
+    push:
+        branches:
+            - main
+        tags:
+            - v*
+    pull_request:
+        branches:
+            - main
+            - prep-**
+    workflow_dispatch:
+        inputs:
+          logLevel:
+
+            default: warning
+            description: "Log level"
+            required: true
+          tags:
+            description: "Test scenario tags"
+jobs:
+  lint:
+    name: Check linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
+      - name: Display Python version
+        run: python -c "import sys; import os; print(\"\n\".join(os.environ[\"PATH\"].split(os.pathsep))); print(sys.version); print(sys.executable);"
+      - name: Upgrade setuptools, pip and wheel
+        run: python -m pip install -U setuptools pip wheel
+      - name: Install tox
+        run: python -m pip install tox
+      - name: Set PY
+        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: Run fix_lint
+        run: python -m tox -e fix_lint
+
+  test:
+   name: Test ${{ matrix.os.download_name }}-${{ matrix.python-version }}-${{ matrix.cloud-provider }}
+   needs: lint
+   runs-on: ${{ matrix.os.image_name }}
+   strategy:
+    fail-fast: false
+    matrix:
+      os:
+       - image_name: ubuntu-latest
+         download_name: manylinux_x86_64
+       - image_name: macos-latest
+         download_name: macosx_x86_64
+       - image_name: windows-2019
+         download_name: win_amd64
+      python-version: ["3.7"]
+      cloud-provider: [aws, azure, gcp]
+   steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Display Python version
+      run: python -c "import sys; print(sys.version)"
+    - name: Setup parameters file
+      shell: bash
+      env:
+        PARAMETERS_SECRET: ${{ secrets.PARAMETERS_SECRET }}
+      run: |
+        gpg --quiet --batch --yes --decrypt --passphrase="$PARAMETERS_SECRET" \
+        .github/workflows/parameters/parameters_${{ matrix.cloud-provider }}.py.gpg > test/parameters.py
+    - name: Upgrade setuptools, pip and wheel
+      run: python -m pip install -U setuptools pip wheel
+    - name: Install tox
+      run: python -m pip install --pre tox
+    - name: Run tests
+      run: python -m tox -e "py${PYTHON_VERSION/\./}" --skip-missing-interpreters false
+      env:
+        PYTHON_VERSION: ${{ matrix.python-version }}
+        PYTEST_ADDOPTS: -vvv --color=yes --tb=short
+        TOX_PARALLEL_NO_SPINNER: 1
+    - name: Combine coverages
+      run: python -m tox -e coverage --skip-missing-interpreters false
+      shell: bash
+    - uses: actions/upload-artifact@v2
+      with:
+        name: coverage_${{ matrix.os.download_name }}-${{ matrix.python-version }}-${{ matrix.cloud-provider }}
+        path: |
+          .tox/.coverage
+          .tox/coverage.xml
+
+  combine-coverage:
+    if: ${{ success() || failure() }}
+    name: Combine coverage
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/download-artifact@v2
+        with:
+          path: artifacts
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Upgrade setuptools and pip
+        run: python -m pip install -U setuptools pip wheel
+      - name: Install tox
+        run: python -m pip install tox
+      - name: Collect all coverages to one dir
+        run: |
+          python -c '
+          from pathlib import Path
+          import shutil
+          src_dir = Path("artifacts")
+          dst_dir = Path(".") / ".tox"
+          dst_dir.mkdir()
+          for src_file in src_dir.glob("*/.coverage"):
+              dst_file = dst_dir / ".coverage.{}".format(src_file.parent.name[9:])
+              print("{} copy to {}".format(src_file, dst_file))
+              shutil.copy(str(src_file), str(dst_file))'
+      - name: Combine coverages
+        run: python -m tox -e coverage
+      - name: Publish html coverage
+        uses: actions/upload-artifact@v2
+        with:
+          name: overall_cov_html
+          path: .tox/htmlcov
+      - name: Publish xml coverage
+        uses: actions/upload-artifact@v2
+        with:
+          name: overall_cov_xml
+          path: .tox/coverage.xml
+      - uses: codecov/codecov-action@v1
+        with:
+          file: .tox/coverage.xml

.github/workflows/parameters/parameters_aws.py.gpg

@@ -0,0 +1,2 @@
+�	y�g��c�T���f
Fy4�y�V
+ߋ����lXa�RyH���/�X����
苬��;�'�R�'��Ό�pgXק[_n�Q���}Ǿ�� :�C��
9"�d��r%wI�eM��P4��³�f�;>�T��)ScF�Y>)�D��0����r�
]�+G��]O�fs+��_�#K��@�Bh�$°���mBr�]-锞�K�Ov|��w��B���~+s��g>c���ɚ�":G�Q�����ٶ㊢ʄ��{L_�[�+2�ʮ�| ]����)�R�\g'��}�1�w�a��5��	�Nχ�A_:f

.github/workflows/parameters/parameters_azure.py.gpg

@@ -0,0 +1,4 @@
+�	Q�ݴ�A%���g
(v'����I���B�s2qڎ�1�&�n��pqr����\��g��ɫ�5�'���J3��*ڔ�Q�,7�S����r�;�:=�� ��#;B�(����u�]cƭ�㽺(EL�����'�����/ک��S�
+]0I���b�ez?
�HQ� �4
+b�\�+]Ň��3���Kz}h�T�)Y�>��H{�8$���&2)$����.��W?MeZL�T�vVc\TU�q���ٸD��*+���e��_�f`�g�^�Cq���,��J�z�ཚ2
+�5��{�'��u�6 �

.github/workflows/parameters/parameters_gcp.py.gpg

@@ -1,13 +1,11 @@
 exclude: '^(.*egg.info.*|.*/parameters.py).*$'
 repos:
 -   repo: https://github.com/asottile/seed-isort-config
-    rev: v1.9.1
+    rev: v2.2.0
     hooks:
     -   id: seed-isort-config
-        # This work around is necessary until we break the monorepo apart
-        entry: bash -c "cd Python/snowflake/sqlalchemy && seed-isort-config"
 -   repo: https://github.com/pre-commit/mirrors-isort
-    rev: v4.3.21
+    rev: v5.10.1
     hooks:
     -   id: isort
 -   repo: https://github.com/pre-commit/pre-commit-hooks
@@ -16,12 +14,11 @@ repos:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: check-yaml
+        exclude: .github/repo_meta.yaml
     -   id: debug-statements
     -   id: flake8
-        entry: bash -c "cd Python/snowflake/sqlalchemy && flake8"
         additional_dependencies: ["flake8-bugbear == 19.3.0"]
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v1.19.0
+    rev: v2.32.1
     hooks:
     -   id: pyupgrade
-        entry: bash -c "cd Python/snowflake/sqlalchemy && pyupgrade"

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-This package includes the Snowflake SQLAlchemy, which supports Snowsql dialects for SQLAlchemy 
+This package includes the Snowflake SQLAlchemy, which supports Snowsql dialects for SQLAlchemy
 http://www.sqlalchemy.org/
 
 Snowflake Documentation is available at:
@@ -16,11 +16,11 @@ Release Notes
    - Add support for geography type
    - Fixed a bug where foreign key's referred schema was set incorrectly
    - Disabled new SQLAlchemy option for statement caching until support gets added
-   
+
 - v1.3.3(December 19,2021)
 
    - Fixed an issue where quote arguments were stripped from identifiers.
-   
+
 - v1.3.2 (September 14,2021)
 
     - Fixed a breaking change introduced in SQLAlchemy 1.4 that changed the behavior of returns_unicode_strings.
@@ -38,13 +38,13 @@ Release Notes
     - Fixed an issue where inspector would not properly switch to table wide column retrieving when schema wide column retrieving was taking too long to respond.
 
 - v1.2.3 (March 30, 2020)
- 
+
     - Update tox.ini
     - Add external stage to COPY INTO custom command.
     - Bumped pandas to newest versions
 
 - v1.2.2 (March 9, 2020)
- 
+
     - Allow get_table_comment to fetch view comments too
 
 - v1.2.1 (February 18,2020)
@@ -77,7 +77,7 @@ Release Notes
     - Fix SQLAlchemy not working with global url
 
 - v1.1.15 (September 30, 2019)
-   
+
     - Incorrect SQL generated for INSERT with CTE
     - Type Synonyms not exported to top-level module #109
 
@@ -107,14 +107,14 @@ Release Notes
 
 - v1.1.9 (February 11, 2019)
 
-    - Fix an issue in v1.1.8 
+    - Fix an issue in v1.1.8
 
 - v1.1.8 (February 8, 2019)
 
     - Fixed a dependency
 
 - v1.1.7 (February 8, 2019)
-		
+
     - Added Upsert in sql-alchemy
     - CopyIntoS3 command in SQLAlchemy
 

DESCRIPTION.rst

@@ -9,7 +9,7 @@ Snowflake SQLAlchemy
 
 .. image:: http://img.shields.io/:license-Apache%202-brightgreen.svg
     :target: http://www.apache.org/licenses/LICENSE-2.0.txt
-    
+
 Snowflake SQLAlchemy runs on the top of the Snowflake Connector for Python as a `dialect <http://docs.sqlalchemy.org/en/latest/dialects/>`_ to bridge a Snowflake database and SQLAlchemy applications.
 
 Prerequisites
@@ -64,7 +64,7 @@ Verifying Your Installation
             connection.close()
             engine.dispose()
 
-#. Replace :code:`<your_user_login_name>`, :code:`<your_password>`, and :code:`<your_account_name>` with the appropriate values for your Snowflake account and user. For more details, see `Connection Parameters`_ (in 
+#. Replace :code:`<your_user_login_name>`, :code:`<your_password>`, and :code:`<your_account_name>` with the appropriate values for your Snowflake account and user. For more details, see `Connection Parameters`_ (in
    this topic).
 
 #. Execute the sample code. For example, if you created a file named :code:`validate.py`:
@@ -89,9 +89,9 @@ Snowflake SQLAlchemy uses the following syntax for the connection string used to
 
     .. code-block:: python
 
-     'snowflake://<user_login_name>:<password>@<account_name>' 
+     'snowflake://<user_login_name>:<password>@<account_name>'
 
-Where: 
+Where:
 
 - :code:`<user_login_name>` is the login name for your Snowflake user.
 - :code:`<password>` is the password for your Snowflake user.
@@ -113,12 +113,12 @@ You can optionally specify the initial database and schema for the Snowflake ses
 The following example calls the :code:`create_engine` method with the user name :code:`testuser1`, password :code:`0123456`, account name :code:`abc123`, database :code:`testdb`, schema :code:`public`, warehouse :code:`testwh`, and role :code:`myrole`:
 
     .. code-block:: python
-      
+
         from sqlalchemy import create_engine
         engine = create_engine(
             'snowflake://testuser1:0123456@abc123/testdb/public?warehouse=testwh&role=myrole'
         )
- 
+
 Other parameters, such as :code:`timezone`, can also be specified as a URI parameter or in :code:`connect_args` parameters. For example:
 
     .. code-block:: python
@@ -128,7 +128,7 @@ Other parameters, such as :code:`timezone`, can also be specified as a URI param
             'snowflake://testuser1:0123456@abc123/testdb/public?warehouse=testwh&role=myrole',
             connect_args={
                 'timezone': 'America/Los_Angeles',
-            } 
+            }
         )
 
 For convenience, you can use the :code:`snowflake.sqlalchemy.URL` method to construct the connection string and connect to the database. The following example constructs the same connection string from the previous example:
@@ -157,7 +157,7 @@ Use the supported environment variables, :code:`HTTPS_PROXY`, :code:`HTTP_PROXY`
 Opening and Closing Connection
 -------------------------------------------------------------------------------
 
-Open a connection by executing :code:`engine.connect()`; avoid using :code:`engine.execute()`. Make certain to close the connection by executing :code:`connection.close()` before 
+Open a connection by executing :code:`engine.connect()`; avoid using :code:`engine.execute()`. Make certain to close the connection by executing :code:`connection.close()` before
 :code:`engine.dispose()`; otherwise, the Python Garbage collector removes the resources required to communicate with Snowflake, preventing the Python connector from closing the session properly.
 
     .. code-block:: python
@@ -183,7 +183,7 @@ Auto-increment Behavior
 Auto-incrementing a value requires the :code:`Sequence` object. Include the :code:`Sequence` object in the primary key column to automatically increment the value as each new record is inserted. For example:
 
     .. code-block:: python
-     
+
             t = Table('mytable', metadata,
                 Column('id', Integer, Sequence('id_seq'), primary_key=True),
                 Column(...), ...
@@ -220,9 +220,9 @@ The following example shows the round trip of :code:`numpy.datetime64` data:
             role='myrole',
             numpy=True,
         ))
-    
+
         specific_date = np.datetime64('2016-03-04T12:03:05.123456789Z')
-        
+
         connection = engine.connect()
         connection.execute(
             "CREATE OR REPLACE TABLE ts_tbl(c1 TIMESTAMP_NTZ)")
@@ -238,7 +238,7 @@ The following :code:`NumPy` data types are supported:
 - numpy.float64
 - numpy.datatime64
 
-Cache Column Metadata 
+Cache Column Metadata
 -------------------------------------------------------------------------------
 
 SQLAlchemy provides `the runtime inspection API <http://docs.sqlalchemy.org/en/latest/core/inspection.html>`_ to get the runtime information about the various objects. One of the common use case is get all tables and their column metadata in a schema in order to construct a schema catalog. For example, `alembic <http://alembic.zzzcomputing.com/>`_ on top of SQLAlchemy manages database schema migrations. A pseudo code flow is as follows:
@@ -255,8 +255,8 @@ SQLAlchemy provides `the runtime inspection API <http://docs.sqlalchemy.org/en/l
 
 In this flow, a potential problem is it may take quite a while as queries run on each table. The results are cached but getting column metadata is expensive.
 
-To mitigate the problem, Snowflake SQLAlchemy takes a flag :code:`cache_column_metadata=True` such that all of column metadata for all tables are cached when :code:`get_table_names` is called and the rest of :code:`get_columns`, :code:`get_primary_keys` and :code:`get_foreign_keys` can take advantage of the cache.  
-        
+To mitigate the problem, Snowflake SQLAlchemy takes a flag :code:`cache_column_metadata=True` such that all of column metadata for all tables are cached when :code:`get_table_names` is called and the rest of :code:`get_columns`, :code:`get_primary_keys` and :code:`get_foreign_keys` can take advantage of the cache.
+
     .. code-block:: python
 
         engine = create_engine(URL(