10592831335

Committed 28 Aug 2024 08:14AM UTC coverage: 74.12% (+0.2%) from 73.933%

Build # 10592831335

Build Type

push

github

Committed by

haiiliin

Commit Message

Add future annotations imports for all files

Run Details

339 of 375 new or added lines in 375 files covered. (90.4%)

34 existing lines in 34 files now uncovered.

24507 of 33064 relevant lines covered (74.12%)

0.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/abaqus/InputFileParser/InputFile.py

from __future__ import annotations

from abqpy.decorators import abaqus_class_doc, abaqus_method_doc

from ..UtilityAndView.abaqusConstants import Boolean


@abaqus_class_doc
class InputFile:
    """The InputFile object is used to store the definitions in an Abaqus input file. InputFile objects can be
    created using the methods described in this section.

    .. note::
        This object can be accessed by::

            import inpParser
    """

    #: A String specifying the source file name of the Abaqus input file.
    file: str = ""

    #: A String specifying the directory where the input file is located.
    directory: str = ""

    #: A sequence of Strings specifying any additional input files included in the specified
    #: input file.
    includes: tuple = ()

    #: A sequence of Strings for input files included in the specified input file that could
    #: not be located.
    missingIncludes: tuple = ()

    @abaqus_method_doc
    def __init__(self, file: str, directory: str = ""):
        """This method creates an InputFile object by reading an Abaqus input file.

        .. note::
            This function can be accessed by::

                inpParser.InputFile

        Parameters
        ----------
        file
            A String specifying the path to the input file.
        directory
            A String specifying the path to the directory containing the input file.

        Returns
        -------
        InputFile
            An InputFile object.
        """
        ...

    @abaqus_method_doc
    def parse(
        self,
        organize: Boolean = False,
        verbose: Boolean = False,
        bulk: Boolean = True,
        usePyArray: Boolean = False,
    ):
        """This method parses the input file associated with the InputFile object.

        Parameters
        ----------
        organize
            A Boolean specifying whether keywords should be organized into suboptions. The default
            is False.
        verbose
            A Boolean specifying whether verbose output is to be printed. If **verbose** is True,
            information about fatal errors is printed. If no fatal errors occur, there is no output.
            The default is False.
        bulk
            A Boolean specifying whether the input file includes bulk data that should be parsed.
            The default is True.
        usePyArray
            A Boolean specifying that parse method can return an AbaqusNDarray object for a keyword
            data value. In cases where large amounts of numerical data (i.e., large node arrays) are
            expected, it is recommended that you use the option usePyArray=True. The default is
            False.

        Returns
        -------
        KeywordSequence
            A KeywordSequence object.

        Raises
        ------
        ValueError
            If you parse an input file more than once, a ValueError is raised for each subsequent
            parsing.
        """
        ...

NEW 1	from __future__ import annotations	×
2
UNCOV 3	from abqpy.decorators import abaqus_class_doc, abaqus_method_doc	×
4
5	from ..UtilityAndView.abaqusConstants import Boolean	×
6
7
8	@abaqus_class_doc	×
9	class InputFile:	×
10	"""The InputFile object is used to store the definitions in an Abaqus input file. InputFile objects can be
11	created using the methods described in this section.
12
13	.. note::
14	This object can be accessed by::
15
16	import inpParser
17	"""
18
19	#: A String specifying the source file name of the Abaqus input file.
20	file: str = ""	×
21
22	#: A String specifying the directory where the input file is located.
23	directory: str = ""	×
24
25	#: A sequence of Strings specifying any additional input files included in the specified
26	#: input file.
27	includes: tuple = ()	×
28
29	#: A sequence of Strings for input files included in the specified input file that could
30	#: not be located.
31	missingIncludes: tuple = ()	×
32
33	@abaqus_method_doc	×
34	def __init__(self, file: str, directory: str = ""):	×
35	"""This method creates an InputFile object by reading an Abaqus input file.
36
37	.. note::
38	This function can be accessed by::
39
40	inpParser.InputFile
41
42	Parameters
43	----------
44	file
45	A String specifying the path to the input file.
46	directory
47	A String specifying the path to the directory containing the input file.
48
49	Returns
50	-------
51	InputFile
52	An InputFile object.
53	"""
54	...	×
55
56	@abaqus_method_doc	×
57	def parse(	×
58	self,
59	organize: Boolean = False,
60	verbose: Boolean = False,
61	bulk: Boolean = True,
62	usePyArray: Boolean = False,
63	):
64	"""This method parses the input file associated with the InputFile object.
65
66	Parameters
67	----------
68	organize
69	A Boolean specifying whether keywords should be organized into suboptions. The default
70	is False.
71	verbose
72	A Boolean specifying whether verbose output is to be printed. If verbose is True,
73	information about fatal errors is printed. If no fatal errors occur, there is no output.
74	The default is False.
75	bulk
76	A Boolean specifying whether the input file includes bulk data that should be parsed.
77	The default is True.
78	usePyArray
79	A Boolean specifying that parse method can return an AbaqusNDarray object for a keyword
80	data value. In cases where large amounts of numerical data (i.e., large node arrays) are
81	expected, it is recommended that you use the option usePyArray=True. The default is
82	False.
83
84	Returns
85	-------
86	KeywordSequence
87	A KeywordSequence object.
88
89	Raises
90	------
91	ValueError
92	If you parse an input file more than once, a ValueError is raised for each subsequent
93	parsing.
94	"""
95	...	×

haiiliin / abqpy / 10592831335

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous