11.0.0: issue with faker.sphinx module

[kloczek]

• Faker version: 11.0.0
• OS: Linux/x86/64

I'm trying to package your module as an rpm package. So I'm using the typical PEP517 based build, install and test cycle used on building packages from non-root account.

• python3 -sBm build -w
• install .whl file in </install/prefix>
• run pytest with PYTHONPATH pointing to sitearch and sitelib inside </install/prefix>

During that process using above methodology I found that sometbig odd is with faker.sphinx module.
That is not installed and is used by test suite.
Here is pytest output:

+ PYTHONPATH=/home/tkloczko/rpmbuild/BUILDROOT/python-faker-11.0.0-2.fc35.x86_64/usr/lib64/python3.8/site-packages:/home/tkloczko/rpmbuild/BUILDROOT/python-faker-11.0.0-2.fc35.x86_64/usr/lib/python3.8/site-packages
+ /usr/bin/pytest -ra -q tests --ignore tests/providers/test_ssn.py
=========================================================================== test session starts ============================================================================
platform linux -- Python 3.8.12, pytest-6.2.5, py-1.11.0, pluggy-1.0.0
rootdir: /home/tkloczko/rpmbuild/BUILD/faker-11.0.0, configfile: setup.cfg
plugins: Faker-11.0.0
collected 1210 items / 2 errors / 1208 selected

================================================================================== ERRORS ==================================================================================
_____________________________________________________________ ERROR collecting tests/sphinx/test_docstring.py ______________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/faker-11.0.0/tests/sphinx/test_docstring.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.8/importlib/__init__.py:127: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests/sphinx/test_docstring.py:8: in <module>
    from faker.sphinx.docstring import DEFAULT_SAMPLE_SIZE, DEFAULT_SEED, ProviderMethodDocstring, Sample
E   ModuleNotFoundError: No module named 'faker.sphinx'
_____________________________________________________________ ERROR collecting tests/sphinx/test_validator.py ______________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/faker-11.0.0/tests/sphinx/test_validator.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.8/importlib/__init__.py:127: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests/sphinx/test_validator.py:6: in <module>
    from faker.sphinx.validator import SampleCodeValidator
E   ModuleNotFoundError: No module named 'faker.sphinx'
========================================================================= short test summary info ==========================================================================
ERROR tests/sphinx/test_docstring.py
ERROR tests/sphinx/test_validator.py
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Interrupted: 2 errors during collection !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
============================================================================ 2 errors in 3.76s =============================================================================

That fails because faker/sphinx directory is not part of the installed resources.
If faker.sphinx module is only part of the test suite IMO it should be moved under tests/ or if it may have some general use case it should be installed.
Am I rigt?🤔

[fcurella]

I'm tempted to just include the module. I don't think it's going to cause any problem.

[kloczek]

I'm tempted to just include the module. I don't think it's going to cause any problem.

Just tested new 11.2.0 and looks like decision still has not been made :P

[github-actions]

This issue is stale because it has been open for 30 days with no activity.

[github-actions]

This issue was closed because it has been inactive for 14 days since being marked as stale.