[BUG] transitstacks.io.example_dir() loops over non-existent dir

[thekaveman]

Describe the bug

When calling this method with a non-existent directory name, the code attempts to loop over that directory to build a list of available examples. It should instead loop over the root of the examples directory.

To Reproduce

See the Run output from the Python package GitHub Action

Failing tests

• tests/test_basic.py:test_csv_io()

Triggering line of code

transitstacks/io.py:139:

def example_dir(example_name: str):
    """Takes an example name and returns the directory.

    Args:
        example_name: name of example
    """
    
    package_dir = os.path.dirname(os.path.abspath(__file__))
    main_example_dir = os.path.join(os.path.dirname(package_dir), "examples")

    example_dir = os.path.join(main_example_dir, example_name)
    
    if not os.path.exists(example_dir):
        available_examples = [
            name for name in os.listdir(example_dir) if os.path.isdir(name)  #<---- error here
        ]

Thoughts on resolution

def example_dir(example_name: str):
    """Takes an example name and returns the directory.

    Args:
        example_name: name of example
    """
    
    package_dir = os.path.dirname(os.path.abspath(__file__))
    main_example_dir = os.path.join(os.path.dirname(package_dir), "examples")

    example_dir = os.path.join(main_example_dir, example_name)
    
    if not os.path.exists(example_dir):
        available_examples = [
            name for name in os.listdir(main_example_dir) if os.path.isdir(name)  #<---- os.listdir(main_example_dir)
        ]

Full stack trace

[thekaveman]

Below is output from the failing test run:

===================================== FAILURES ===========================================
____________________________________ test_csv_io _________________________________________
    def test_csv_io():
>       EXAMPLE_DIR = ts.example_dir("prototype")

tests/test_basic.py:26:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
example_name = 'prototype'

    def example_dir(example_name: str):
        """Takes an example name and returns the directory.

        Args:
            example_name: name of example
        """
        package_dir = os.path.dirname(os.path.abspath(__file__))
        main_example_dir = os.path.join(os.path.dirname(package_dir), "examples")

        example_dir = os.path.join(main_example_dir, example_name)

        if not os.path.exists(example_dir):
            available_examples = [
                name for name in os.listdir(main_example_dir) if os.path.isdir(name)
            ]
            ex_str = "\n - ".join(available_examples)
            msg = f"{example_name} not an available example. \
                Available examples:\n - {ex_str}"
>           raise ValueError(msg)
E           ValueError: prototype not an available example.             Available examples:
E            -

transitstacks/io.py:144: ValueError

It seems that the test expects the examples/prototype folder to exist and contain some information:

def test_csv_io():
    EXAMPLE_DIR = ts.example_dir("prototype")
    stack_dict = ts.read_stack_from_dir(EXAMPLE_DIR)
    missing_sheets = set(expected_sheets) - set(list(stack_dict.keys()))
    if missing_sheets:
        print(f"Missing sheets: {missing_sheets}")
    assert not missing_sheets
    assert all(type(x) == pd.DataFrame for x in stack_dict.values())

@e-lo are we missing content in this repo?