Improve reference naming #624

tvt173 · 2022-08-22T20:29:42Z

Hi @joamatab , this PR makes reference naming more reliable, by replacing the alias and aliases attributes with a property called name on ComponentReference and corresponding property named_references on Component. Because named_references is a calculated property, it is guaranteed to always stay in sync with Component.references. Because name and owner are both changed to properties, we also guard against strange cases where either are changed midway through creating a component.

I know the deprecation of alias/aliases may be controversial, but for now they should be smoothly deprecated with a DeprecationWarning. There should be no breaking changes, except the user is no longer allowed to explicitly set Component.aliases (which they never should have done anyways)

… instead of alias

sourcery-ai · 2022-08-22T20:30:22Z

Sourcery Code Quality Report

✅ Merging this PR will increase code quality in the affected files by 0.91%.

Quality metrics	Before	After	Change
Complexity	7.84 ⭐	7.42 ⭐	-0.42 👍
Method Length	67.64 🙂	64.65 🙂	-2.99 👍
Working memory	7.06 🙂	7.60 🙂	0.54 👎
Quality	64.58% 🙂	65.49% 🙂	0.91% 👍

Other metrics	Before	After	Change
Lines	2770	2795	25

Changed files	Quality Before	Quality After	Quality Change
gdsfactory/cell.py	47.64% 😞	48.79% 😞	1.15% 👍
gdsfactory/component.py	69.49% 🙂	69.80% 🙂	0.31% 👍
gdsfactory/component_reference.py	69.22% 🙂	70.29% 🙂	1.07% 👍
gdsfactory/copy.py	49.43% 😞	50.54% 🙂	1.11% 👍
gdsfactory/get_netlist.py	66.04% 🙂	67.56% 🙂	1.52% 👍
gdsfactory/components/component_sequence.py	49.36% 😞	50.24% 🙂	0.88% 👍

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
gdsfactory/cell.py	cell_without_validator	48 ⛔	633 ⛔		5.51% ⛔	Refactor to reduce nesting. Try splitting into smaller methods
gdsfactory/component.py	Component.write_gds	14 🙂	286 ⛔	16 ⛔	31.47% 😞	Try splitting into smaller methods. Extract out complex expressions
gdsfactory/components/component_sequence.py	component_sequence	15 🙂	321 ⛔	14 😞	31.90% 😞	Try splitting into smaller methods. Extract out complex expressions
gdsfactory/component_reference.py	ComponentReference.move	15 🙂	280 ⛔	15 😞	31.99% 😞	Try splitting into smaller methods. Extract out complex expressions
gdsfactory/component.py	Component.remove_layers	22 😞	222 ⛔	11 😞	35.70% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions