fakesnow 0.9.35__py3-none-any.whl → 0.9.37__py3-none-any.whl

{fakesnow-0.9.35.dist-info → fakesnow-0.9.37.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fakesnow
-Version: 0.9.35
+Version: 0.9.37
 Summary: Fake Snowflake Connector for Python. Run, mock and test Snowflake DB locally.
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -204,7 +204,8 @@ License:                                  Apache License
            See the License for the specific language governing permissions and
            limitations under the License.
         
-Project-URL: homepage, https://github.com/tekumara/fakesnow
+Project-URL: Source, https://github.com/tekumara/fakesnow
+Project-URL: Changelog, https://github.com/tekumara/fakesnow/blob/main/CHANGELOG.md
 Keywords: snowflake,snowflakedb,fake,local,mock,testing
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.9
@@ -213,23 +214,7 @@ License-File: LICENSE
 Requires-Dist: duckdb~=1.2.0
 Requires-Dist: pyarrow
 Requires-Dist: snowflake-connector-python
-Requires-Dist: sqlglot~=26.12.1
-Provides-Extra: dev
-Requires-Dist: build~=1.0; extra == "dev"
-Requires-Dist: dirty-equals; extra == "dev"
-Requires-Dist: pandas-stubs; extra == "dev"
-Requires-Dist: snowflake-connector-python[pandas,secure-local-storage]; extra == "dev"
-Requires-Dist: pre-commit~=4.0; extra == "dev"
-Requires-Dist: pyarrow-stubs==17.19; extra == "dev"
-Requires-Dist: pytest~=8.0; extra == "dev"
-Requires-Dist: pytest-asyncio; extra == "dev"
-Requires-Dist: ruff~=0.11.0; extra == "dev"
-Requires-Dist: twine~=6.0; extra == "dev"
-Requires-Dist: snowflake-sqlalchemy~=1.7.0; extra == "dev"
-Provides-Extra: notebook
-Requires-Dist: duckdb-engine; extra == "notebook"
-Requires-Dist: ipykernel; extra == "notebook"
-Requires-Dist: jupysql; extra == "notebook"
+Requires-Dist: sqlglot~=26.16.2
 Provides-Extra: server
 Requires-Dist: starlette; extra == "server"
 Requires-Dist: uvicorn; extra == "server"
@@ -242,7 +227,7 @@ Dynamic: license-file
 [![PyPI](https://img.shields.io/pypi/v/fakesnow?color=violet)](https://pypi.org/project/fakesnow/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/fakesnow?color=violet)](https://pypi.org/project/fakesnow/)
 
-Fake [Snowflake Connector for Python](https://docs.snowflake.com/en/user-guide/python-connector). Run and mock Snowflake DB locally.
+Run, mock and test fake Snowflake databases locally.
 
 ## Install
 
@@ -250,9 +235,21 @@ Fake [Snowflake Connector for Python](https://docs.snowflake.com/en/user-guide/p
 pip install fakesnow
 ```
 
+Or to install with the server:
+
+```
+pip install fakesnow[server]
+```
+
 ## Usage
 
-Run script.py with fakesnow:
+fakesnow offers two main approaches for faking Snowflake: [in-process patching](#in-process-patching) of the Snowflake Connector for Python or a [standalone HTTP server](#run-fakesnow-as-a-server).
+
+Patching only applies to the current Python process. If a subprocess is spawned it won't be patched. For subprocesses, or for non-Python clients, use the server instead.
+
+### In-process patching
+
+To run script.py with patching:
 
 ```shell
 fakesnow script.py
@@ -266,9 +263,9 @@ fakesnow -m pytest
 
 `fakesnow` executes `fakesnow.patch` before running the script or module.
 
-### fakesnow.patch
+#### Use fakesnow.patch in your code
 
-To use fakesnow within your code:
+Alternatively, use fakesnow.patch in your code:
 
 ```python
 import fakesnow
@@ -280,12 +277,16 @@ with fakesnow.patch():
     print(conn.cursor().execute("SELECT 'Hello fake world!'").fetchone())
 ```
 
-The following imports are automatically patched:
+#### What gets patched
+
+The following standard imports are automatically patched:
 
 - `import snowflake.connector.connect`
 - `import snowflake.connector.pandas_tools.write_pandas`
 
-To patch modules that use the `from ... import` syntax, manually specify them, eg: if _mymodule.py_ has the import:
+#### Handling "from ... import" Statements
+
+To patch modules that use the `from ... import` syntax, you need to manually specify them, eg: if _mymodule.py_ contains:
 
 ```python
 from snowflake.connector.pandas_tools import write_pandas
@@ -298,33 +299,83 @@ with fakesnow.patch("mymodule.write_pandas"):
     ...
 ```
 
-By default databases are in-memory. To persist databases between processes, specify a databases path:
+#### Database Persistence
+
+By default, databases are in-memory and will be lost when the process ends. To persist databases between processes, specify a databases path:
 
 ```python
 with fakesnow.patch(db_path="databases/"):
     ...
 ```
 
+### Run fakesnow as a server
+
+For scenarios where patching won't work (like subprocesses or non-Python clients), you can run fakesnow as an HTTP server:
+
+```python
+import fakesnow
+import snowflake.connector
+
+# Start the fakesnow server in a context manager
+# This yields connection kwargs (host, port, etc.)
+with fakesnow.server() as conn_kwargs:
+    # Connect to the fakesnow server using the yielded kwargs
+    with snowflake.connector.connect(**conn_kwargs) as conn:
+        print(conn.cursor().execute("SELECT 'Hello fake server!'").fetchone())
+
+    # The server is automatically stopped when exiting the context manager
+```
+
+This starts an HTTP server in its own thread listening for requests on localhost on an available random port.
+The server accepts any username/password combination.
+
+#### Server Configuration Options
+
+By default, the server uses a single in-memory database for its lifetime. To configure database persistence or isolation:
+
+```python
+# Databases will be saved to the "databases/" directory
+with fakesnow.server(session_parameters={"FAKESNOW_DB_PATH": "databases/"}):
+    ...
+
+# Each connection gets its own isolated in-memory database
+with fakesnow.server(session_parameters={"FAKESNOW_DB_PATH": ":isolated:"}):
+    ...
+```
+
+To specify a port for the server:
+
+```python
+with fakesnow.server(port=12345) as conn_kwargs:
+    ...
+```
+
 ### pytest fixtures
 
-pytest [fixtures](fakesnow/fixtures.py) are provided for testing. Example _conftest.py_:
+fakesnow provides [fixtures](fakesnow/fixtures.py) for easier test integration. Add them in _conftest.py_:
+
+```python
+pytest_plugins = "fakesnow.fixtures"
+```
+
+To autouse the fixture you can wrap it like this in _conftest.py_:
 
 ```python
 from typing import Iterator
 
-import fakesnow.fixtures
 import pytest
 
-pytest_plugins = fakesnow.fixtures.__name__
+pytest_plugins = "fakesnow.fixtures"
 
 @pytest.fixture(scope="session", autouse=True)
 def setup(_fakesnow_session: None) -> Iterator[None]:
     # the standard imports are now patched
-    ...
+    # Add any additional setup here
     yield
+    # Add any teardown here
 ```
 
-Or with `from ... import` patch targets:
+For code that uses `from ... import` statements:
 
 ```python
 from typing import Iterator
@@ -332,40 +383,72 @@ from typing import Iterator
 import fakesnow
 import pytest
 
+pytest_plugins = "fakesnow.fixtures"
+
 @pytest.fixture(scope="session", autouse=True)
 def _fakesnow_session() -> Iterator[None]:
     with fakesnow.patch("mymodule.write_pandas"):
         yield
 ```
 
+#### server fixture
+
+To start a fakesnow server instance, enable the plugin in _conftest.py_:
+
+```python
+pytest_plugins = "fakesnow.fixtures"
+```
+
+And then use the `fakesnow_server` session fixture like this:
+
+```python
+import snowflake.connector
+
+def test_with_server(fakesnow_server: dict):
+    # fakesnow_server contains connection kwargs (host, port, etc.)
+    with snowflake.connector.connect(**fakesnow_server) as conn:
+        conn.cursor().execute("SELECT 1")
+        assert conn.cursor().fetchone() == (1,)
+```
+
 ## Implementation coverage
 
-- [x] cursors and standard SQL
-- [x] [get_result_batches()](https://docs.snowflake.com/en/user-guide/python-connector-api#get_result_batches)
-- [x] information schema
-- [x] multiple databases
-- [x] [parameter binding](https://docs.snowflake.com/en/user-guide/python-connector-example#binding-data)
-- [x] table comments
-- [x] [write_pandas(..)](https://docs.snowflake.com/en/user-guide/python-connector-api#write_pandas)
-- [ ] [access control](https://docs.snowflake.com/en/user-guide/security-access-control-overview)
-- [ ] standalone/out of process api/support for faking non-python connectors
-- [ ] [stored procedures](https://docs.snowflake.com/en/sql-reference/stored-procedures)
+Fully supported:
+
+- Standard SQL operations and cursors
+- Information schema queries
+- Multiple databases
+- [Parameter binding](https://docs.snowflake.com/en/user-guide/python-connector-example#binding-data) in queries
+- Table comments
+- Pandas integration including [write_pandas(..)](https://docs.snowflake.com/en/user-guide/python-connector-api#write_pandas) (not available via the server yet)
+- Result batch retrieval via [get_result_batches()](https://docs.snowflake.com/en/user-guide/python-connector-api#get_result_batches)
+- HTTP server for non-Python connectors
+
+Partially supported:
 
-Partial support
+- Date functions
+- Regular expression functions
+- Semi-structured data operations
+- Tags
+- User management
+- `COPY INTO` from S3 sources, see [COPY INTO](#copy-into)
 
-- [x] date functions
-- [x] regex functions
-- [x] semi-structured data
-- [x] tags
-- [x] user management (See [tests/test_users.py](tests/test_users.py))
+Not yet implemented:
 
-For more detail see [tests/test_fakes.py](tests/test_fakes.py)
+- [Access control](https://docs.snowflake.com/en/user-guide/security-access-control-overview)
+- [Stored procedures](https://docs.snowflake.com/en/sql-reference/stored-procedures)
+
+For more detail see the [test suite](tests/).
 
 ## Caveats
 
-- The order of rows is non deterministic and may not match Snowflake unless ORDER BY is fully specified.
-- A more liberal Snowflake SQL dialect than used by a real Snowflake instance is supported, ie: some queries might pass using fakesnow that a real Snowflake instance would reject.
+- Row ordering is non-deterministic and may differ from Snowflake unless you fully specify the ORDER BY clause.
+- fakesnow supports a more liberal SQL dialect than actual Snowflake. This means some queries that work with fakesnow might not work with a real Snowflake instance.
+
+## COPY INTO
+
+`COPY INTO` can be used from S3 sources. By default the standard AWS credential chain will be used. If you are getting an HTTP 403 or need to provide alternative S3 credentials you can use the duckdb [CREATE SECRET](https://duckdb.org/docs/stable/extensions/httpfs/s3api) statement. For an example of creating a secret to use a moto S3 endpoint see `s3_client` in [conftest.py](tests/conftest.py#L80)
 
 ## Contributing
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) to get started and develop in this repo.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on getting started with development and contributing to this project.

fakesnow-0.9.37.dist-info/RECORD

@@ -0,0 +1,32 @@
+fakesnow/__init__.py,sha256=71Rk_3s_4eTDCi7-bbo-xT71WN0E0MAPf5qjsguIeJU,5117
+fakesnow/__main__.py,sha256=GDrGyNTvBFuqn_UfDjKs7b3LPtU6gDv1KwosVDrukIM,76
+fakesnow/arrow.py,sha256=XjTpFyLrD9jULWOtPgpr0RyNMmO6a5yi82y6ivi2CCI,4884
+fakesnow/checks.py,sha256=be-xo0oMoAUVhlMDCu1_Rkoh_L8p_p8qo9P6reJSHIQ,2874
+fakesnow/cli.py,sha256=9qfI-Ssr6mo8UmIlXkUAOz2z2YPBgDsrEVaZv9FjGFs,2201
+fakesnow/conn.py,sha256=diCwcjaCBrlCn9PyjbScfIQTNQjqiPTkQanUTqcvblE,6009
+fakesnow/converter.py,sha256=wPOfsFXIUJNJSx5oFNAxh13udxmAVIIHsLK8BiGkXGA,1635
+fakesnow/copy_into.py,sha256=JT4SpynozlcdmWwzlQwwncPiuHCE5UUv-XGX_CI9s90,7235
+fakesnow/cursor.py,sha256=so8OET_ZLlvRyxanKORfGU8gSiIa71FKILsS45lh0cE,22287
+fakesnow/expr.py,sha256=CAxuYIUkwI339DQIBzvFF0F-m1tcVGKEPA5rDTzmH9A,892
+fakesnow/fakes.py,sha256=JQTiUkkwPeQrJ8FDWhPFPK6pGwd_aR2oiOrNzCWznlM,187
+fakesnow/fixtures.py,sha256=2rj0MTZlaZc4PNWhaqC5IiiLa7E9G0QZT3g45YawsL0,633
+fakesnow/info_schema.py,sha256=AYmTIHxk5Y6xdMTgttgBL1V0VO8qiM2T1-gKwkLmWDs,8720
+fakesnow/instance.py,sha256=OKoYXwaI6kL9HQpnHx44yzpON_xNfuIT_F4oJNF_XXQ,2114
+fakesnow/logger.py,sha256=U6EjUENQuTrDeNYqER2hxazoySmXzLmZJ-t-SDZgjkg,363
+fakesnow/macros.py,sha256=bQfZR5ptO4Gk-8fFRK2iksqYWkJUT8e-rPp-000qzu0,999
+fakesnow/pandas_tools.py,sha256=wI203UQHC8JvDzxE_VjE1NeV4rThek2P-u52oTg2foo,3481
+fakesnow/py.typed,sha256=B-DLSjYBi7pkKjwxCSdpVj2J02wgfJr-E7B1wOUyxYU,80
+fakesnow/rowtype.py,sha256=QUp8EaXD5LT0Xv8BXk5ze4WseEn52xoJ6R05pJjs5mM,2729
+fakesnow/server.py,sha256=RHf7ffKYi5xBH9fh8wZr3tEPmnzFWuvUbziCC8UwTh4,6652
+fakesnow/variables.py,sha256=C3y_9u7LuVtARkpcim3ihgVWg6KKdz1hSVeW4YI7oL4,3014
+fakesnow/transforms/__init__.py,sha256=jHbn7T6fSxhiu3KVn_Xupi5JwgY9SbjcfGU-0WpdELU,2769
+fakesnow/transforms/merge.py,sha256=Pg7_rwbAT_vr1U4ocBofUSyqaK8_e3qdIz_2SDm2S3s,8320
+fakesnow/transforms/show.py,sha256=0NjuLQjodrukfUw8mcxcAmtBkV_6r02mA3nuE3ad3rE,17458
+fakesnow/transforms/transforms.py,sha256=kjkQGTSkZ5lOJ-G13WQL4uB4yTzoIcsa3qcgBAgPH0c,47985
+fakesnow-0.9.37.dist-info/licenses/LICENSE,sha256=kW-7NWIyaRMQiDpryfSmF2DObDZHGR1cJZ39s6B1Svg,11344
+tools/decode.py,sha256=kC5kUvLQxdCkMRsnH6BqCajlKxKeN77w6rwCKsY6gqU,1781
+fakesnow-0.9.37.dist-info/METADATA,sha256=6tfEtq0EvcWJEor8o4E-XgwkpO-gd5rh2o6EZ7BqRcc,20680
+fakesnow-0.9.37.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+fakesnow-0.9.37.dist-info/entry_points.txt,sha256=2riAUgu928ZIHawtO8EsfrMEJhi-EH-z_Vq7Q44xKPM,47
+fakesnow-0.9.37.dist-info/top_level.txt,sha256=Yos7YveA3f03xVYuURqnBsfMV2DePXfu_yGcsj3pPzI,30
+fakesnow-0.9.37.dist-info/RECORD,,

{fakesnow-0.9.35.dist-info → fakesnow-0.9.37.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.7.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

fakesnow-0.9.35.dist-info/RECORD

@@ -1,29 +0,0 @@
-fakesnow/__init__.py,sha256=qUfgucQYPdELrJaxczalhJgWAWQ6cfTCUAHx6nUqRaI,3528
-fakesnow/__main__.py,sha256=GDrGyNTvBFuqn_UfDjKs7b3LPtU6gDv1KwosVDrukIM,76
-fakesnow/arrow.py,sha256=XjTpFyLrD9jULWOtPgpr0RyNMmO6a5yi82y6ivi2CCI,4884
-fakesnow/checks.py,sha256=be-xo0oMoAUVhlMDCu1_Rkoh_L8p_p8qo9P6reJSHIQ,2874
-fakesnow/cli.py,sha256=9qfI-Ssr6mo8UmIlXkUAOz2z2YPBgDsrEVaZv9FjGFs,2201
-fakesnow/conn.py,sha256=2WClMmUgfQkQA2hFQjfMP3R-85TbTbZh_8Y1tCdcerA,6053
-fakesnow/converter.py,sha256=xoBFnfBbGWQyUQAVr6zi-RyglU8A7A3GSlwLPkH1dzI,1621
-fakesnow/cursor.py,sha256=e-nY-w25xmLs1jdhIbO6mwzBHVIUKYIkzR37Wnf3Cfc,22068
-fakesnow/expr.py,sha256=CAxuYIUkwI339DQIBzvFF0F-m1tcVGKEPA5rDTzmH9A,892
-fakesnow/fakes.py,sha256=JQTiUkkwPeQrJ8FDWhPFPK6pGwd_aR2oiOrNzCWznlM,187
-fakesnow/fixtures.py,sha256=G-NkVeruSQAJ7fvSS2fR2oysUn0Yra1pohHlOvacKEk,455
-fakesnow/info_schema.py,sha256=AYmTIHxk5Y6xdMTgttgBL1V0VO8qiM2T1-gKwkLmWDs,8720
-fakesnow/instance.py,sha256=OKoYXwaI6kL9HQpnHx44yzpON_xNfuIT_F4oJNF_XXQ,2114
-fakesnow/macros.py,sha256=pX1YJDnQOkFJSHYUjQ6ErEkYIKvFI6Ncz_au0vv1csA,265
-fakesnow/pandas_tools.py,sha256=wI203UQHC8JvDzxE_VjE1NeV4rThek2P-u52oTg2foo,3481
-fakesnow/py.typed,sha256=B-DLSjYBi7pkKjwxCSdpVj2J02wgfJr-E7B1wOUyxYU,80
-fakesnow/rowtype.py,sha256=QUp8EaXD5LT0Xv8BXk5ze4WseEn52xoJ6R05pJjs5mM,2729
-fakesnow/server.py,sha256=6EMdNMxL0DgfMNXfFBqRFYmRThbuEVFFpa_1sCW-rZ4,6519
-fakesnow/variables.py,sha256=C3y_9u7LuVtARkpcim3ihgVWg6KKdz1hSVeW4YI7oL4,3014
-fakesnow/transforms/__init__.py,sha256=eJ_XH9pKO4Mxb7MKVgJuo6Wea-LYahF1dc_py5lPHAY,49471
-fakesnow/transforms/merge.py,sha256=Pg7_rwbAT_vr1U4ocBofUSyqaK8_e3qdIz_2SDm2S3s,8320
-fakesnow/transforms/show.py,sha256=0NjuLQjodrukfUw8mcxcAmtBkV_6r02mA3nuE3ad3rE,17458
-fakesnow-0.9.35.dist-info/licenses/LICENSE,sha256=kW-7NWIyaRMQiDpryfSmF2DObDZHGR1cJZ39s6B1Svg,11344
-tools/decode.py,sha256=kC5kUvLQxdCkMRsnH6BqCajlKxKeN77w6rwCKsY6gqU,1781
-fakesnow-0.9.35.dist-info/METADATA,sha256=D2aDpQUAIuSHEf6W5f1m84IG3BBDEvvMN5fU_FiWl3c,18128
-fakesnow-0.9.35.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-fakesnow-0.9.35.dist-info/entry_points.txt,sha256=2riAUgu928ZIHawtO8EsfrMEJhi-EH-z_Vq7Q44xKPM,47
-fakesnow-0.9.35.dist-info/top_level.txt,sha256=Yos7YveA3f03xVYuURqnBsfMV2DePXfu_yGcsj3pPzI,30
-fakesnow-0.9.35.dist-info/RECORD,,