Skip to content

Commit

Permalink
init project
Browse files Browse the repository at this point in the history
  • Loading branch information
GreyElaina committed Sep 18, 2024
0 parents commit da5d14f
Show file tree
Hide file tree
Showing 10 changed files with 720 additions and 0 deletions.
83 changes: 83 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: Build

on:
push:
tags:
- 'build/*'
pull_request:
types:
- opened
paths:
- '.github/workflows/**'
- 'src/elaina_triehard/*_c.c'
- 'src/elaina_triehard/*_c.pyx'
release:
types: [published]

concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true

permissions:
contents: read

jobs:
build_sdist:
name: Build sdist
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up PDM
uses: pdm-project/setup-pdm@v4
- name: Build sdist
run: |
NO_CYTHON=1 pdm build --no-wheel
- uses: actions/upload-artifact@v3
with:
path: dist/*.tar.gz

build_wheels:
name: Build wheels on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-13, macos-14]

steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v5
- name: Install cibuildwheel
run: python -m pip install cibuildwheel==2.21.1

- name: Build wheels
run: python -m cibuildwheel --output-dir wheelhouse

- uses: actions/upload-artifact@v4
with:
name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
path: ./wheelhouse/*.whl

release:
name: Release
runs-on: ubuntu-latest
if: github.event_name == 'release'
needs: [build_sdist, build_wheels]
permissions:
contents: write
packages: write
id-token: write
environment: release
steps:
- uses: actions/checkout@v3
- name: Download artifact
uses: actions/download-artifact@v3
with:
name: artifact
path: dist
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
- name: upload release asset
run: |
gh release upload ${{ github.event.release.tag_name }} dist/*
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
162 changes: 162 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm-project.org/#use-with-ide
.pdm.toml
.pdm-python
.pdm-build/

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# trie-hard-cython
30 changes: 30 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
[project]
name = "elaina-triehard"
version = "0.1.0"
description = "Default template for PDM package"
authors = [
{name = "Elaina", email = "[email protected]"},
]
dependencies = []
requires-python = ">=3.9"
readme = "README.md"
license = {text = "MIT"}

[build-system]
requires = ["setuptools>=61", "wheel", "Cython>3"]
build-backend = "setuptools.build_meta"

[tool.pdm]
distribution = true

[tool.pdm.dev-dependencies]
dev = [
"Cython>=3.0.11",
]

[tool.setuptools]
py-modules = ["elaina_triehard"]

[tool.cibuildwheel]
# don't build PyPy wheels, install from source instead
skip = "pp*"
21 changes: 21 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
from setuptools import setup, Extension
from os import environ

if environ.get("NO_CYTHON"):
setup(
package_dir={"": "src"},
packages=["elaina_triehard"],
include_package_data=True,
exclude_package_data={"": ["*.c"]},
)
exit()

setup(
ext_modules=(
[
Extension("elaina_triehard.impl_c", ["src/elaina_triehard/impl_c.c"]),
]
),
include_package_data=True,
exclude_package_data={"": ["*.c"]},
)
6 changes: 6 additions & 0 deletions src/elaina_triehard/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
try:
from .impl_c import TrieHard as TrieHard
from .impl_c import TrieHardNode as TrieHardNode
except ImportError:
from .impl_py import TrieHard as TrieHard
from .impl_py import TrieHardNode as TrieHardNode
27 changes: 27 additions & 0 deletions src/elaina_triehard/impl_c.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
"""
This type stub file was generated by cyright.
"""

class TrieHardNode:
"""
TrieHard 的节点类。
"""
def __init__(self, mask: int, children_indices: list[int], is_terminal: bool = False) -> None:
...



class TrieHard:
"""
TrieHard 的主类。
"""
def __init__(self, strings: list[str]) -> None:
"""
初始化 TrieHard,并根据给定的字符串列表构建 Trie。
"""
...

def get_closest_prefix(self, key: str) -> str:
"""
获取 Trie 中与给定字符串最接近的前缀。
"""
Loading

0 comments on commit da5d14f

Please sign in to comment.