Class architecture refactoring #22
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ass and replaced with a private method in TuPostProcessingGui class
…nd StatusBar classes in gui_widgets module
…ses dealing with the reading of Direct-Access files
…rator' class with a dataclass and its methods with two functions providing the functionalities for building the dataclass and running the plotting executable
…classes with a single one storing all the characteristics and with 'group' attribute being of type 'GroupType'; added a function changing this dataclass default values
…Field' class name into 'LabelledCombobox' to help its understanding
…dsConfigurator' class with a corresponding dataclass and a function configuring and returning an instance of this dataclass
…configuration.py' module
…module Moved 'IDGA' and 'IANT' enums in the newly created 'support' module. These enums now have elements defined as tuples of two values, the first being an index, the second a descriptive string. Two properties have been defined for accessing the elements of the tuple.
Substituted class 'LabelImage' with a function that builds an instance of the 'ttk.Label' class. This function loads and assigns the image to the label and returns the built object.
Replaced 'PliReader' class with a dataclass and its method with a function that read the information from the .pli file and returns a properly configured object of this dataclass, which stores all the extracted information.
…hanges The class 'TabContentBuilder' has been made abstract. Its methods 'set_times' and '_build_configuration_fields' have been defined with the proper decorator, so to be implemented by the derived classes. The arguments of the 'set_times' method have been changed into **kwargs: proper checks have been introduced in order to be sure that the right arguments are passed.
The argument of the 'set_times' method for the 'TuStatTabContentBuilder' class had an incorrect check on the required argument. Now the correct name has been provided.
…dule The 'support.py' module has been added to the repository.
The inner methods of the 'TuInp' dataclass have been substituted with two functions each one returning an object of type 'TuInp' with its attributes appropriately filled according to the 'TuPlot' or the 'TuStat' case.
…itance removal The inheritance from the 'object' class has been removed from the 'WidgetTooltip' class, since useless.
lelaus
approved these changes
Jul 21, 2024
lelaus
approved these changes
Jul 21, 2024
lelaus
approved these changes
Jul 21, 2024
lelaus
requested changes
Jul 21, 2024
There was a problem hiding this comment.
Something to change relating to task 4:
- in function
init_DatGenerator(), assign the result of the instantiation of the dataclassDatGeneratorto a variable; - call the function
run_plot_files_generation()by passing the above created variable directly within the functioninit_DatGenerator(); - rename the function
init_DatGenerator()asinit_run_DatGenerator(); - make the function
init_DatGenerator()return the instance ofDatGenerator.
This way, the instantiation and run instructions in main.py are joined, the safety being increased.
lelaus
requested changes
Jul 21, 2024
There was a problem hiding this comment.
Something to change relating to task 5 to improve the readability and the modularity:
- to move the function
define_group_from_num()as static method into the dataclassDiagramCharacteristics; - to change the arguments of the function
define_group_from_num()by passing all the data needed to build and return an instance of the dataclassDiagramCharacteristics; - to make the function
define_group_from_num()create from scratch the dataclass to return.
lelaus
approved these changes
Jul 21, 2024
lelaus
requested changes
Jul 21, 2024
There was a problem hiding this comment.
Something to change relating to task 7 to improve the readability and the modularity:
- to move the function
init_GuiPlotFieldsConfigurator_attrs()as static method into the dataclassGuiPlotFieldsConfigurator; - to move all the functions called by
init_GuiPlotFieldsConfigurator_attrs()into the dataclassGuiPlotFieldsConfiguratoras private methods.
lelaus
approved these changes
Jul 21, 2024
lelaus
reviewed
Jul 21, 2024
tugui/gui_widgets.py
Outdated
| """ | ||
| Class that provides a label filled with an image. | ||
| Method that provides a label filled with an image. It builds an instance |
There was a problem hiding this comment.
Please, change "Method" into "Function" since outside a class.
lelaus
approved these changes
Jul 21, 2024
lelaus
requested changes
Jul 21, 2024
lelaus
approved these changes
Jul 21, 2024
lelaus
requested changes
Jul 21, 2024
There was a problem hiding this comment.
Something to change relating to task 12 to improve the readability and the modularity:
- to move the function
configure_tuplot_inp_fields()as static method into the dataclassTuInp; - to move the function
configure_tustat_inp_fields()as static method into the dataclassTuInp;
lelaus
approved these changes
Jul 21, 2024
lelaus
requested changes
Jul 21, 2024
Changes requested from review #22 (review) of task 4 have been managed. A static method has been added to the 'DatGenerator' dataclass that builds and returns an object of it. It calls the function 'run_plot_files_generation()' as well. The name 'init_DatGenerator_and_run_exec()' has been choosen for the static method instead of the one indicated in the review.
Some modifications have been made errouneously in commit deb2d13. Now the version of the master has been restored.
lelaus
reviewed
Jul 22, 2024
Changes requested from review #22 (review) of task 5 have been managed. A static method has been added to the 'DiagramCharacteristics' dataclass that builds and returns an object of it. This method also configures the 'group' attribute according to the plot number value.
Changes requested from review #22 (review) of task 7 have been managed. The function 'init_GuiPlotFieldsConfigurator_attrs()' has been made a static method of the 'GuiPlotFieldsConfigurator' dataclass. This method builds and returns an object of the dataclass. In addition, the previously called functions from this method have been changed into private methods of the 'GuiPlotFieldsConfigurator' dataclass.
Change requested from review comment #22 (comment) has been managed. Changed 'Method' to 'Function' in the docstring for the 'provide_label_image()' function in the 'gui_widgets.py' module.
Changes requested from review #22 (review) have been managed. The function 'init_PliReader()' has been moved as a static method into the 'PliReader' dataclass. An improper instantiation of the 'PliReader' dataclass in the 'save_loaded_inp()' method of the 'InpHandler' class has been corrected as well.
Changes requested from review #22 (review) have been managed. The functions 'configure_tuplot_inp_fields()' and 'configure_tustat_inp_fields()' have been moved as static methods into the 'TuInp' dataclass.
lelaus
reviewed
Jul 22, 2024
lelaus
requested changes
Jul 22, 2024
There was a problem hiding this comment.
Modifications requested in the review of task 7 have been satisfactorily handled.
One additional modification is suggested: to change the methods _check_config_file_existence(), _check_exe_file_existence() and _build_nVsKn() into private methods since they are used only in the class factory method
lelaus
reviewed
Jul 22, 2024
lelaus
reviewed
Jul 22, 2024
lelaus
reviewed
Jul 22, 2024
Changes requested from review comment #22 (review) have been managed. The methods '_check_config_file_existence()', '_check_exe_file_existence()' and '_build_nVsKn()' have been changed into private methods.
lelaus
approved these changes
Jul 22, 2024
|
Before closing this pull request, I'd suggest to insert the UML diagram of the currently implemented code. |
|
The UML diagram of the currently implemented code is the following one. |
|
All the required modifications have been applied successfully and the UML diagram of the resulting code architecture has been loaded. The branch can now be merged into the master branch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All the tasks concerning the issue #1 have been managed. Waiting for the review.