Functions | |
def | create_test_file (file_name="part_test_objects", file_path=os.environ["HOME"], save=False) |
def parttests.part_test_objects.create_test_file | ( | file_name = "part_test_objects" , |
|
file_path = os.environ["HOME"] , |
|||
save = False |
|||
) |
Create a complete test file of Part objects. It draws a frame with information on the software used to create the test document, and fills it with every object that can be created. Parameters ---------- file_name: str, optional It defaults to `'part_test_objects'`. It is the name of the document that is created. The `file_name` will be appended to `file_path` to determine the actual path to save. The extension `.FCStd` will be added automatically. file_path: str, optional It defaults to the value of `os.environ['HOME']` which in Linux is usually `'/home/user'`. If it is the empty string `''` it will use the value returned by `App.getUserAppDataDir()`, for example, `'/home/user/.FreeCAD/'`. save: bool, optional It defaults to `False`. If it is `True` the new document will be saved to disk after creating all objects. Returns ------- App::Document A reference to the test document that was created.
References parttests.part_test_objects.create_test_file().
Referenced by parttests.part_test_objects.create_test_file().