brandtbucher / specialist Goto Github PK

Pretty!

I'd love to be able to integrate the output of specialist into my docs, just like I already integrate coverage reports. I'm probably a bit early 😄

This is a cool tool!

It looks like all the color coding is currently done in the ROYG range. Redder means less specialized, greener means more specialized.

But code can be unspecialized either because it wasn't run enough, or because it was run enough but had some other issue. The former case isn't very interesting, while the latter is potentially actionable.

So I suggest using red just for things that could be specialized but aren't, and BIV colors for things that aren't specialized for boring reasons (not run enough, implemented in C, etc). This will make it immediately clear where the problem areas are.

Running something like

python -m specialist --output specialist --targets example/__init__.py example/__init__.py

fails with

  File "/lib64/python3.11/site-packages/specialist.py", line 443, in <genexpr>
    (path_, output / path_.relative_to(common).with_suffix(".html"))
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib64/python3.11/pathlib.py", line 694, in with_suffix
    raise ValueError("%r has an empty name" % (self,))
ValueError: PosixPath('.') has an empty name

It seems the problem is in

                common = pathlib.Path(
                    os.path.commonpath(paths)  # pylint: disable = no-member
                ).resolve()

This assumes there is more than one file and common will end up as a directory.

Adding this right below seems to fix it

                if not common.is_dir():
                    common = common.parent

An alternative method would be to check the length of paths.

I get the following error no matter how I try to invoke specialist:

Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "D:\Dev\conway-2023\.env\Scripts\specialist.exe\__main__.py", line 4, in <module>
    import shutil
    ^^^^^^^^^^^^^^
  File "D:\Dev\conway-2023\.env\Lib\site-packages\specialist.py", line 78, in <module>
    os.path.commonpath([sysconfig.get_path("stdlib"), sysconfig.get_path("purelib")])
  File "<frozen ntpath>", line 814, in commonpath
ValueError: Paths don't have the same drive

Amazing tool! The documentation is good but it was a bit confusing when it came to integration with pytest. I would run the following:

specialist -m pytest ./tests/test_file.py

which would get me the result:

specialist: No quickened code found in pytest! Try modifying it to run longer, or use the --targets option to analyze different source files.

what wasn't clear was the --targets meant the source code I wanted to see was quickened. I think I was assuming it would automatically know which classes I meant (how would it??). It wasn't until I figured out the following syntax that I started getting incredibly helpful results!

specialist --targets ./module/class_the_test_exercises.py -m pytest ./tests/test_file.py