AwesomeExamplesTest Class Reference

Inheritance diagram for AwesomeExamplesTest:

Collaboration diagram for AwesomeExamplesTest:

Public Member Functions
def	test_examples (self)

Protected Member Functions
def	_test_examples_dir (self, str path_to_glob)

Detailed Description

 Test our awesome examples. 

Definition at line 37 of file awesome_examples.py.

Member Function Documentation

_test_examples_dir()

def _test_examples_dir (   self, str   path_to_glob  )

protected

Internal function to test a directory full of example scripts.

Parameters:
    path_to_glob (str): the path to a directory to search for python
        scripts.

Definition at line 40 of file awesome_examples.py.

    ):
        """
        Internal function to test a directory full of example scripts.
 
        Parameters:
            path_to_glob (str): the path to a directory to search for python
                scripts.
        """
        # Do not run the test if we are in a light release.
        if light_release():
            return
        working_dir = find_file(path_to_glob)
        examples = sorted(glob.glob(f'{working_dir}/*.py'))
        for example in examples:
            filename = os.path.basename(example)
            with self.subTest(msg=filename):
                result = subprocess.run(
                    ["basf2", "-n1", example],
                    stdout=subprocess.PIPE,
                    stderr=subprocess.STDOUT,
                )
                if result.returncode != 0:
                    # failure running example so let's print the output
                    # on stderr so it's not split from output of unittest
                    # done like this since we don't want to decode/encode utf8
                    sys.stdout.buffer.write(result.stdout)
                self.assertEqual(result.returncode, 0)
 

test_examples()

def test_examples

(

self

)

Run the examples of the awesome package. 

Definition at line 71 of file awesome_examples.py.

    def test_examples(self):
        """Run the examples of the awesome package. """
 
        self._test_examples_dir(
            path_to_glob='online_book/awesome/examples',
        )
 
 

---

The documentation for this class was generated from the following file:

• online_book/awesome/tests/awesome_examples.py