Add aluminum sections #12

youandvern · 2024-04-10T03:57:22Z

No description provided.

sourcery-ai

Hey @youandvern - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟡 Testing: 4 issues found
🟡 Complexity: 1 issue found
🟢 Docstrings: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

sourcery-ai · 2024-04-10T03:59:24Z

efficalc/sections/section_query.py

+def get_aluminum_angle(section_size: str) -> AluminumAngle:
+    """
+    Fetches the properties of a specified Aluminum Angle section from the sections database and returns a
+    :class:`efficalc.sections.AluminumAngle` instance populated with these properties.
+
+    :param section_size: The designation of the aluminum section size as the Size property defined in the database.
+    :type section_size: str
+    :return: An AluminumAngle populated with the properties of the specified section size.
+    :rtype: `efficalc.sections.AluminumAngle`
+    :raises ValueError: If the specified section size cannot be found in the sections database.
+    """
+
+    row = _fetch_aluminum_section_row(ALUM_ANGLE_TABLE, section_size)
+
+    if row:
+        return AluminumAngle(**row)
+    else:
+        raise ValueError(
+            f"The aluminum angle section size named {section_size} could not be found."


suggestion (code_refinement): Consider consolidating aluminum section retrieval functions.

The functions for retrieving aluminum section properties (angle, channel, circular, rectangular, wide flange) are very similar. Consider refactoring to reduce code duplication, perhaps by using a more generic function that takes the section type as an argument.

sourcery-ai · 2024-04-10T03:59:24Z

tests/sections/test_section_query.py

@@ -100,3 +105,76 @@ def test_wide_flange_lookup_size_not_found():
    with pytest.raises(ValueError) as e_info:
        get_aisc_wide_flange("NOT_FOUND")
    assert "section size named NOT_FOUND could not be found" in str(e_info.value)
+
+
+def test_aluminum_angle_lookup():


suggestion (testing): Consider adding negative test cases for aluminum sections.

It's great to see positive test cases for aluminum sections. However, adding negative test cases where invalid inputs are provided could enhance the robustness of the tests. This could include scenarios where the section size does not exist in the database.

Suggested change

def test_aluminum_angle_lookup():

def test_aluminum_angle_lookup_invalid_format():

with pytest.raises(ValueError) as e_info:

get_aluminum_angle("INVALID_FORMAT")

assert "Invalid format for aluminum angle section" in str(e_info.value)

def test_aluminum_channel_lookup_invalid_dimensions():

with pytest.raises(ValueError) as e_info:

get_aluminum_channel("C 0 X 0")

assert "Invalid dimensions for aluminum channel section" in str(e_info.value)

sourcery-ai · 2024-04-10T03:59:24Z

tests/sections/test_section_query.py

@@ -100,3 +105,76 @@
    with pytest.raises(ValueError) as e_info:
        get_aisc_wide_flange("NOT_FOUND")
    assert "section size named NOT_FOUND could not be found" in str(e_info.value)
+
+
+def test_aluminum_angle_lookup():


suggestion (testing): Consider parameterizing tests for aluminum sections.

Given the similarity across tests for different aluminum section types, consider using pytest's parameterize feature. This could reduce code duplication and make it easier to extend tests in the future.

sourcery-ai · 2024-04-10T03:59:24Z

tests/sections/test_section_query.py

@@ -100,3 +105,76 @@
    with pytest.raises(ValueError) as e_info:
        get_aisc_wide_flange("NOT_FOUND")
    assert "section size named NOT_FOUND could not be found" in str(e_info.value)
+
+
+def test_aluminum_angle_lookup():


suggestion (testing): Missing test cases for edge conditions.

The current tests cover basic functionality but seem to miss edge conditions, such as extremely large or small section sizes. Adding these could ensure the system behaves correctly under all circumstances.

Suggested change

def test_aluminum_angle_lookup():

def test_aluminum_angle_lookup_extreme_sizes():

large_section = get_aluminum_angle("L 12 x 12 x 1")

assert large_section.d == 12

assert large_section.b == 12

assert large_section.t == 1

small_section = get_aluminum_angle("L 0.5 x 0.5 x 0.125")

assert small_section.d == 0.5

assert small_section.b == 0.5

assert small_section.t == 0.125

sourcery-ai · 2024-04-10T03:59:24Z

tests/sections/test_section_query.py

@@ -100,3 +105,76 @@
    with pytest.raises(ValueError) as e_info:
        get_aisc_wide_flange("NOT_FOUND")
    assert "section size named NOT_FOUND could not be found" in str(e_info.value)
+
+
+def test_aluminum_angle_lookup():


suggestion (testing): Ensure consistency in test data.

The test data used across different test cases for aluminum sections should be consistent unless testing specific scenarios. This helps in maintaining clarity and reliability of the tests.

sourcery-ai · 2024-04-10T03:59:25Z

efficalc/sections/section_query.py

+    row = _fetch_aluminum_section_row(ALUM_CIRCULAR_TABLE, section_size)
+
+    if row:


suggestion (code-quality): Use named expression to simplify assignment and conditional (use-named-expression)

Suggested change

row = _fetch_aluminum_section_row(ALUM_CIRCULAR_TABLE, section_size)

if row:

if row := _fetch_aluminum_section_row(ALUM_CIRCULAR_TABLE, section_size):

sourcery-ai · 2024-04-10T03:59:25Z

efficalc/sections/section_query.py

+    row = _fetch_aluminum_section_row(ALUM_RECTANGULAR_TABLE, section_size)
+
+    if row:


suggestion (code-quality): Use named expression to simplify assignment and conditional (use-named-expression)

Suggested change

row = _fetch_aluminum_section_row(ALUM_RECTANGULAR_TABLE, section_size)

if row:

if row := _fetch_aluminum_section_row(

ALUM_RECTANGULAR_TABLE, section_size

):

sourcery-ai · 2024-04-10T03:59:25Z

efficalc/sections/section_query.py

+    row = _fetch_aluminum_section_row(ALUM_WIDE_FLANGE_TABLE, section_size)
+
+    if row:


suggestion (code-quality): Use named expression to simplify assignment and conditional (use-named-expression)

Suggested change

row = _fetch_aluminum_section_row(ALUM_WIDE_FLANGE_TABLE, section_size)

if row:

if row := _fetch_aluminum_section_row(

ALUM_WIDE_FLANGE_TABLE, section_size

):

sourcery-ai · 2024-04-10T03:59:25Z

utils/pythonize_csv.py

+    contents = ""
+    contents += "("


suggestion (code-quality): Replace assignment and augmented assignment with single assignment (merge-assign-and-aug-assign)

Suggested change

contents = ""

contents += "("

contents = "" + "("

sourcery-ai · 2024-04-10T03:59:26Z

utils/pythonize_csv.py

+    contents = ""
+    contents += "("


suggestion (code-quality): Replace assignment and augmented assignment with single assignment (merge-assign-and-aug-assign)

Suggested change

contents = ""

contents += "("

contents = "" + "("

youandvern added 2 commits March 23, 2024 23:18

Reset cached PyPI badge in readme

1620e74

Add aluminum section properties

2f61263

sourcery-ai bot reviewed Apr 10, 2024

View reviewed changes

youandvern merged commit f52038b into main Apr 10, 2024
4 checks passed

youandvern linked an issue Apr 10, 2024 that may be closed by this pull request

Support Aluminum Section Sizes #5

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add aluminum sections #12

Add aluminum sections #12

youandvern commented Apr 10, 2024

sourcery-ai bot left a comment

sourcery-ai bot Apr 10, 2024

sourcery-ai bot Apr 10, 2024

sourcery-ai bot Apr 10, 2024

sourcery-ai bot Apr 10, 2024

sourcery-ai bot Apr 10, 2024

sourcery-ai bot Apr 10, 2024

sourcery-ai bot Apr 10, 2024

sourcery-ai bot Apr 10, 2024

sourcery-ai bot Apr 10, 2024

sourcery-ai bot Apr 10, 2024

-def test_aluminum_angle_lookup():
+def test_aluminum_angle_lookup_invalid_format():
+    with pytest.raises(ValueError) as e_info:
+        get_aluminum_angle("INVALID_FORMAT")
+    assert "Invalid format for aluminum angle section" in str(e_info.value)
+def test_aluminum_channel_lookup_invalid_dimensions():
+    with pytest.raises(ValueError) as e_info:
+        get_aluminum_channel("C 0 X 0")
+    assert "Invalid dimensions for aluminum channel section" in str(e_info.value)

-def test_aluminum_angle_lookup():
+def test_aluminum_angle_lookup_extreme_sizes():
+    large_section = get_aluminum_angle("L 12 x 12 x 1")
+    assert large_section.d == 12
+    assert large_section.b == 12
+    assert large_section.t == 1
+    small_section = get_aluminum_angle("L 0.5 x 0.5 x 0.125")
+    assert small_section.d == 0.5
+    assert small_section.b == 0.5
+    assert small_section.t == 0.125

		row = _fetch_aluminum_section_row(ALUM_CIRCULAR_TABLE, section_size)

		if row:

		row = _fetch_aluminum_section_row(ALUM_RECTANGULAR_TABLE, section_size)

		if row:

		row = _fetch_aluminum_section_row(ALUM_WIDE_FLANGE_TABLE, section_size)

		if row:

Add aluminum sections #12

Add aluminum sections #12

Conversation

youandvern commented Apr 10, 2024

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot Apr 10, 2024

Choose a reason for hiding this comment