Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conda install: missing filelock when running Sphinx doctests #84

Open
mrmundt opened this issue Feb 16, 2024 · 0 comments
Open

Conda install: missing filelock when running Sphinx doctests #84

mrmundt opened this issue Feb 16, 2024 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@mrmundt
Copy link

mrmundt commented Feb 16, 2024

Description

While attempting to use enum_tools.autoenum via conda installation, doctests fail due to a missing import.

Error message:

Extension error:  
    Could not import extension enum_tools.autoenum (exception: 
    NOTE: In order to use the FileCache you must have 
    filelock installed. You can install it via pip:  
      pip install cachecontrol[filecache]  
    )

Steps to Reproduce

We encountered this issue when adding enum_tools.autoenum to our documentation on Pyomo. The steps below assume you have cloned Pyomo and installed its deps via conda. You can see a real-life log of all steps in our GitHub actions workflows.

conda install enum_tools
make -C doc/OnlineDocs doctest -d

Actual result:

Error message:

Extension error:  
    Could not import extension enum_tools.autoenum (exception: 
    NOTE: In order to use the FileCache you must have 
    filelock installed. You can install it via pip:  
      pip install cachecontrol[filecache]  
    )

Expected result:

Doctests can run without having to also manually installing filelock.

Reproduces how often:

Always unless you manually run conda install filelock in addition to conda install enum_tools

Version

  • Operating System: Windows
  • Python: (All versions tested - 3.8 through 3.12)
  • enum_tools: 0.11.0

Installation source

Anaconda/conda

Other Additional Information:

See this commit for code that will produce failure message: https://github.com/mrmundt/pyomo/tree/23bdbf7b76f674b5d437a3136387e28a84844086
See this commit for workaround implementing filelock: mrmundt/pyomo@d405bcb

@mrmundt mrmundt added the bug Something isn't working label Feb 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants