Knauer US-11518: Types For Timber Design - MoistureClass and ServiceCondition #252

aliciaknauer · 2023-05-03T11:21:19Z

Description

The two functions set_timber_moisture_class and set_timber_service_conditions are implemented here. Since there are some issues with setting the right code, a thorough instruction can be found in every test file on how to test. Because of this reason the pytest.skipif function was added, so it doesn't interfere with existing tests.

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Unit Tests
Attached examples

Test Configuration:

RFEM / RSTAB version: 6.02.0060
Python version: 3.11

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

pull-request-quantifier-deprecated · 2023-05-03T11:21:23Z

This PR has 393 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Large
Size       : +393 -0
Percentile : 79.3%

Total files changed: 7

Change summary by file extension:
.py : +393 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

heetrojivadiya · 2023-05-11T12:18:41Z

RFEM/TypesForTimberDesign/timberMoistureClass.py

+            member_sets (str): Assigned Member Sets
+            surfaces (str): Assigned Surfaces
+            surface_sets (str): Assigned Surface Sets
+            moisture_class (enum): Timber Moisture Class


Description should be Timber Moisture Class Type Enumeration

heetrojivadiya · 2023-05-11T12:22:53Z

RFEM/TypesForTimberDesign/timberServiceCondition.py

+            surfaces (str): Assigned Surfaces
+            surface_sets (str): Assigned Surface Sets
+            standard (int): Code Number
+            moisture_service_condition (enum): Timber Service Condition


description should be Timber Moisture Service Condition Type Enumeration

heetrojivadiya · 2023-05-11T12:24:42Z

RFEM/enums.py

    '''
    OFFSET_TYPE_XY, OFFSET_TYPE_XZ, OFFSET_TYPE_YZ = range(3)
+
+class TimberMoistureClassMoistureClass(Enum):


TimberMoistureClassType is better class name

I'm with Heet on this one.

heetrojivadiya · 2023-05-11T12:25:25Z

RFEM/enums.py

+    '''
+    TIMBER_MOISTURE_CLASS_TYPE_1, TIMBER_MOISTURE_CLASS_TYPE_2, TIMBER_MOISTURE_CLASS_TYPE_3 = range(3)
+
+class TimberServiceConditionsMoistureServiceCondition(Enum):


TimberMoistureServiceConditionType is better class name

I'm with Heet on this one.

heetrojivadiya · 2023-05-11T12:28:32Z

RFEM/TypesForTimberDesign/timberServiceCondition.py

+            surface_sets (str): Assigned Surface Sets
+            standard (int): Code Number
+            moisture_service_condition (enum): Timber Service Condition
+            temperature (enum): Timber Service Conditions Temperature


it would be good to add Enumeration at the end of description for variable type (enum)

OndraMichal

Hi,
please look at branch MichalOndrej-timberServicesAndMoisture and carefully compare the tests. There is a way to execute the tests properly even if the setters are not in the WS.

OndraMichal · 2023-05-16T11:23:38Z

RFEM/TypesForTimberDesign/timberServiceCondition.py

+            clientObject.treatment = treatment_csa
+
+        # Service Condition if Standard NDS(USA) - Service Moisture Conditions, Treatment and Temperature
+        if standard == 6579:


'elif' instead of 'if' should be used. Same with line 91. These statements are mutually exclusive.

OndraMichal · 2023-05-16T11:31:24Z

RFEM/TypesForTimberDesign/timberServiceCondition.py

+        clientObject.surface_sets = ConvertToDlString(surface_sets)
+
+        # Service Condition if Standard CSA - Moisture Service Conditions and Treatment
+        if standard == 6336:


Common code could be separated to enhance readability and maintainability.

parameters = { "current_standard_for_combination_wizard": standard, "activate_combination_wizard_and_classification": True, "activate_combination_wizard": True, "result_combinations_active": True, "result_combinations_parentheses_active": False, "result_combinations_consider_sub_results": False, "combination_name_according_to_action_category": False}), # Service Condition if Standard CSA - Moisture Service Conditions and Treatment if standard == 6336: LoadCasesAndCombinations(params = parameters, ....

OndraMichal · 2023-05-16T11:32:11Z

RFEM/enums.py

    '''
    OFFSET_TYPE_XY, OFFSET_TYPE_XZ, OFFSET_TYPE_YZ = range(3)
+
+class TimberMoistureClassMoistureClass(Enum):


I'm with Heet on this one.

OndraMichal · 2023-05-16T11:32:26Z

RFEM/enums.py

+    '''
+    TIMBER_MOISTURE_CLASS_TYPE_1, TIMBER_MOISTURE_CLASS_TYPE_2, TIMBER_MOISTURE_CLASS_TYPE_3 = range(3)
+
+class TimberServiceConditionsMoistureServiceCondition(Enum):


I'm with Heet on this one.

OndraMichal · 2023-05-16T11:33:22Z

RFEM/TypesForTimberDesign/timberMoistureClass.py

@@ -0,0 +1,70 @@
+from RFEM.initModel import Model, clearAttributes, deleteEmptyAttributes, ConvertToDlString
+from RFEM.enums import TimberMoistureClassMoistureClass
+from RFEM.LoadCasesAndCombinations.loadCasesAndCombinations import LoadCasesAndCombinations


Unused import.

aliciaknauer added 7 commits April 20, 2023 19:05

added timberMoistureClass.py and timberServiceCondition.py

77e2cbd

update

777a6fa

update

0555a8c

update

ff5a478

update

9ce7bf5

update

e6378e4

update

f7f8142

aliciaknauer requested review from dogukankaratas and heetrojivadiya May 3, 2023 11:21

pull-request-quantifier-deprecated bot added the Large label May 3, 2023

heetrojivadiya reviewed May 11, 2023

View reviewed changes

OndraMichal requested changes May 17, 2023

View reviewed changes

OndraMichal merged commit f7f8142 into main May 23, 2023

OndraMichal deleted the knauer-timberserviceandmoisture branch May 23, 2023 05:10

Knauer US-11518: Types For Timber Design - MoistureClass and ServiceCondition #252

Knauer US-11518: Types For Timber Design - MoistureClass and ServiceCondition #252

Uh oh!

Conversation

aliciaknauer commented May 3, 2023

Description

Type of change

How Has This Been Tested?

Checklist:

Uh oh!

pull-request-quantifier-deprecated bot commented May 3, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

heetrojivadiya May 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OndraMichal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

heetrojivadiya May 11, 2023 •

edited

Loading