Skip to content

Conversation

@kayjan
Copy link
Owner

@kayjan kayjan commented May 10, 2025

Description

Follow rules

  • Keep input type generic and output type specific
  • Docstring to remove mention of the type as it is redundant/implied
  • Remove use of mutable defaults
  • Use of Optional if it is okay to pass in None as input

Testing

Additional notes

Checklist

I have read through the contributing guidelines and ensured that

  • I have added a descriptive title for this pull request.
  • I have followed the convention and standards, and my code is checked for style and correctness.
  • I have added test cases, and unit tests pass with 100% code coverage.
  • I have updated the documentation and code docstrings.

Checklist (for reviewer)

  • I have added label (breaking / enhancement / bug / documentation) to this pull request, if applicable.
  • I will ensure this change is captured in the CHANGELOG.md file.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmark

Details
Benchmark suite Current: 3d475d6 Previous: 33ced06 Ratio
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10 18428.644748120794 iter/sec (stddev: 0.0000075348591508237284) 18275.67206584302 iter/sec (stddev: 0.000005343676653843679) 0.99
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100 194.99536973741152 iter/sec (stddev: 0.0038845681770883263) 175.05579859813687 iter/sec (stddev: 0.00463735179359823) 0.90
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000 14.401191930203614 iter/sec (stddev: 0.00010822113722413214) 14.302469823217375 iter/sec (stddev: 0.00047726617673656495) 0.99
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10 88.07366960847182 iter/sec (stddev: 0.00017608118506623097) 85.50359118504815 iter/sec (stddev: 0.00023040904759229937) 0.97
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10_no_assertions 23049.14885298797 iter/sec (stddev: 0.000004740090307734558) 21869.061182996276 iter/sec (stddev: 0.00000449917902880447) 0.95
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100_no_assertions 1903.4447210115306 iter/sec (stddev: 0.0000071728911889771035) 1854.4998372183625 iter/sec (stddev: 0.000012196248472073574) 0.97
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000_no_assertions 175.01743851879615 iter/sec (stddev: 0.00004548980557871704) 170.28623541027738 iter/sec (stddev: 0.0000825826474240258) 0.97
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10_no_assertions 91.57420141013108 iter/sec (stddev: 0.004236428683336799) 86.98469948702737 iter/sec (stddev: 0.00491526314338115) 0.95

This comment was automatically generated by workflow using github-action-benchmark.

@kayjan kayjan changed the title Update type hints Relax type hints May 10, 2025
@kayjan kayjan added the documentation Improvements or additions to documentation label May 10, 2025
@github-actions
Copy link
Contributor

Code Coverage

Package Line Rate Branch Rate Complexity Health
bigtree 100% 100% 0
bigtree.binarytree 100% 100% 0
bigtree.dag 100% 98% 0
bigtree.node 100% 100% 0
bigtree.tree 100% 100% 0
bigtree.tree.construct 100% 100% 0
bigtree.tree.export 100% 100% 0
bigtree.utils 100% 100% 0
Summary 100% (2966 / 2966) 100% (1144 / 1146) 0

@kayjan kayjan merged commit bcd0419 into master May 10, 2025
7 checks passed
@kayjan kayjan deleted the bugfix/type branch May 10, 2025 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants