Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
snakehouse
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
public
snakehouse
Commits
6535dd3d
Commit
6535dd3d
authored
4 years ago
by
Piotr Maślanka
Browse files
Options
Downloads
Patches
Plain Diff
doc notice
parent
6548eb95
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+23
-2
23 additions, 2 deletions
README.md
with
23 additions
and
2 deletions
README.md
+
23
−
2
View file @
6535dd3d
...
...
@@ -12,6 +12,8 @@ snakehouse
snakehouse is a tool to pack mutiple .pyx files
into a single extension.
_There's a **MANDATORY READING** part at the end of this README. Read it or you will be sure to run into trouble._
Inspired by
[
this StackOverflow discussion
](
https://stackoverflow.com/questions/30157363/collapse-multiple-submodules-to-one-cython-extension
)
.
Tested and works on CPython 3.5-3.9,
...
...
@@ -24,8 +26,8 @@ a part of your pull request as well!
Note what have you changed in
[
CHANGELOG.md
](
/CHANGELOG.md
)
as well!
Usage notes
-----------
Usage notes
- MANDATORY READING
-----------
--------------------
Take a look at
[
example
](
example/
)
on how to multi-build your Cython extensions.
Don't place modules compiled that way in root .py file's top level imports.
...
...
@@ -38,3 +40,22 @@ the built module has a tendency to dump core.
Try to debug it first by passing
`dont_snakehouse=True`
to your
modules in the debug mode.
Also note that if you are compiling in
`dont_snakehouse`
mode then your modules should have at least one of the following:
*
a normal Python
`def`
*
a normal Python class (not
`cdef class`
)
*
a line of Python initialization, eg.
```
python
a
=
None
```
or
```
python
import
logging
logger
=
logging
.
getLogger
(
__name__
)
```
Otherwise
`PyInit`
won't be generated by Cython
and such module will be unimportable in Python. Normal import won't suffice.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment