Snowflake Legacy ID Generation

1.0.2 · deprecated · verified Thu Apr 09

The `snowflake-legacy` package (current version 1.0.2) is a transitional Python library providing limited backward compatibility for users of the *original* `snowflake` PyPI package, which has since been renamed to `snowflake-uuid`. The original package was designed for generating persistent, machine-specific UUIDs (often referred to as 'snowflakes'). This `snowflake-legacy` package itself is deprecated, primarily serving as a temporary bridge after the `snowflake` PyPI name was transferred to Snowflake, Inc. Users are strongly advised to migrate to `snowflake-uuid` for continued functionality and support. It has an effectively abandoned release cadence.

Warnings

breaking The `make_snowflake()` function, if present in the original `snowflake` package, is explicitly disabled in `snowflake-legacy` and will always raise a `NotImplementedError`, directing users to the `snowflake-uuid` package.
Fix: Migrate to `snowflake-uuid` and use its API for generating new snowflake IDs.
deprecated The `snowflake-legacy` package itself is a temporary, transitional package and is explicitly recommended to be replaced by `snowflake-uuid`. It is unlikely to receive further maintenance or updates.
Fix: Update your project dependencies from `snowflake-legacy` to `snowflake-uuid` as soon as possible.
gotcha The `snowflake.snowflake()` function in `snowflake-legacy` only *reads* an existing snowflake ID from a file (defaulting to `/etc/snowflake`); it does not create or generate a new ID. If the file does not exist, it will raise a `FileNotFoundError`.
Fix: Ensure that the `snowflake-uuid` package is installed and has run at least once to create the `/etc/snowflake` file if you intend to use `snowflake-legacy` to read it. For generation, switch to `snowflake-uuid`.
gotcha There is a completely unrelated, official `snowflake` package on PyPI owned by Snowflake, Inc. (the data warehousing company). Users attempting to install the ID generation library by searching 'snowflake' and installing the first result may get the wrong package, leading to confusion.
Fix: Always explicitly install `snowflake-uuid` for machine-specific UUID generation, or `snowflake-legacy` if specifically targeting the deprecated transitional package.

Install

pip install snowflake-legacy Install `snowflake-legacy`

Imports

snowflake
```
import snowflake
```
The `snowflake-legacy` package provides an `import snowflake` that mimics the top-level `snowflake` module of the original package. Direct import of `snowflake()` from `snowflake` might imply a function, but it's a module-level callable.

Quickstart

Demonstrates how to use the `snowflake-legacy` package to read a machine's snowflake ID. Note that this package does not generate IDs; it only reads them, typically from `/etc/snowflake`, which would usually be created by the `snowflake-uuid` package. It will raise a `FileNotFoundError` if the ID file doesn't exist. The `make_snowflake()` function is explicitly disabled.

import snowflake
import os

# This package only *reads* a snowflake ID from a file, typically /etc/snowflake.
# It does NOT generate one. For generation, use 'snowflake-uuid'.
# The ID is usually created by the 'snowflake-uuid' package upon installation.
# This example attempts to read it, but will raise FileNotFoundError if not present.

try:
    # Attempt to read the machine's snowflake ID
    # In a real scenario, this would likely read from /etc/snowflake
    # after the `snowflake-uuid` package has been installed and created it.
    # For demonstration, we use a temporary file path if /etc/snowflake isn't available.
    snowflake_id = snowflake.snowflake(os.environ.get('SNOWFLAKE_ID_PATH', '/etc/snowflake'))
    print(f"Machine Snowflake ID: {snowflake_id}")
except FileNotFoundError:
    print("No snowflake ID found. The 'snowflake-legacy' package only reads IDs; it does not generate them.")
    print("Please install 'snowflake-uuid' package (pip install snowflake-uuid) to generate an ID.")
except NotImplementedError as e:
    print(f"Error: {e}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")

view raw JSON →