8000 Use greek small letter mu "\u03bc" instead of micro sign "\u00B5" for micro unit prefix (alt 1) by jbouwh · Pull Request #144853 · home-assistant/core · GitHub
[go: up one dir, main page]
Skip to content

Use greek small letter mu "\u03bc" instead of micro sign "\u00B5" for micro unit prefix (alt 1) #144853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 23 commits into
base: dev
Choose a base branch
from
Open

Use greek small letter mu "\u03bc" instead of micro sign "\u00B5" for micro unit prefix (alt 1) #144853

wants to merge 23 commits into from
+830 −213

Conversation

jbouwh
Copy link
Contributor
@jbouwh jbouwh commented 10000 May 14, 2025 •
edited
Loading

Breaking change

Breaks sensors that pass their unit by config (e.g. YAML) or custom integrations that use the the other unicode. MQTT sensors have been made compatible with equivalent units.

This should be followed op in future PR's..

Proposed change

To represent the micro sign there are 2 different UNICODE characters used:

https://www.compart.com/en/unicode/U+00B5
-> 0xC2 0xB5 b'\xce\xbc' "\u00b5"
µ: MICRO SIGN

https://www.compart.com/en/unicode/U+03BC
-> 0xCE 0xBC b'\xc2\xb5' "\u03bc"
μ: Greek Small Letter Mu

This PR implements the use of "\u03bc" (the Greek small letter mu) to encode the micro unit prefix, instead of the legacy migro sign "\u00B5".

To see the change impact the other way see #144898

According to The Unicode Consortium, the Greek letter character is preferred,[10] but implementations must recognize the micro sign as well, for compatibility with legacy character sets.

So then U+03BC μ GREEK SMALL LETTER MU (Alt+956) should prehaps prevail?

See also: astral-sh/ruff#14433

A pylint linter is added to ensure we use the correct encoding when using MU in a constant or StrEnum assignment

Equivalent units have been added to prevent breaking sensor statistics in the HA recorder.

MQTT sensors allow equivalent units in their configs to prevent breaking.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

jbouwh
jbouwh commented May 14, 2025
View reviewed changes
jbouwh
jbouwh commented May 14, 2025
View reviewed changes
jbouwh
jbouwh commented May 14, 2025
View reviewed changes
@codecov Codecov
Copy link
codecov bot commented May 14, 2025

❌ We are unable to process any of the uploaded JUnit XML files. Please ensure your files are in the right format.

@MartinHjelmare
Copy link
Member

The PR description doesn't match the PR title. In the description it says that we should use b'\xc2\xb5', while in the title it says we should use b'\xce\xbc'

@MartinHjelmare
Copy link
Member

It would be interesting to describe where and how much we use each of the characters today.

@jbouwh jbouwh changed the title Use b'\xce\xbc` for micro sign instead of b'\xc2\xb5' Use b'\xce\xbc` for micro sign instead of b'\xc2\xb5' alt 1 May 14, 2025
@jbouwh jbouwh mentioned this pull request May 14, 2025
Draft
19 tasks
@jbouwh jbouwh changed the title Use b'\xce\xbc` for micro sign instead of b'\xc2\xb5' alt 1 Use Greek micro sign b'\xc2\xb5' for micro sign instead of b'\xce\xbc` alt 1 May 17, 2025
emontnemery
emontnemery reviewed May 21, 2025
View reviewed changes
@jbouwh jbouwh marked this pull request as ready for review May 21, 2025 11:39
@emontnemery emontnemery marked this pull request as draft May 21, 2025 14:08
@emontnemery
Copy link
Contributor

Setting to draft until some discussion on Discord is completed

@jbouwh jbouwh marked this pull request as ready for review May 21, 2025 21:13
@emontnemery emontnemery marked this pull request as draft May 22, 2025 13:28
@emontnemery emontnemery changed the title Use Greek micro sign b'\xc2\xb5' for micro sign instead of b'\xce\xbc` alt 1 Use micro sign b'\xc2\xb5' instead of greek small letter mu b'\xce\xbc` for micro unit prefix (alt 1) May 22, 2025
emontnemery
emontnemery reviewed May 23, 2025
View reviewed changes
@jbouwh jbouwh marked this pull request as ready for review May 28, 2025 06:31
@jbouwh jbouwh marked this pull request as draft May 28, 2025 06:31
@jbouwh jbouwh force-pushed the fix-microsign-alt1 branch from 93e67f3 to 358e27a Compare May 28, 2025 06:41
jbouwh and others added 20 commits May 28, 2025 13:35
@jbouwh
Use b'\xce\xbc` for micro sign instead of b'\xc2\xb5'
b3074d2
@jbouwh
Fix comment
d7086d5
@jbouwh
Use remark # μ == '\u03bc'
9f00dfd
@jbouwh
consequent comments
9202b4d
@jbouwh
Add linter to check correct microchar use
6fa4190
@jbouwh
Fix prometheus
55da0d1
@jbouwh
Stale doc strings
83106c9
@jbouwh
Manage equivalent sensor units for recorder
e1739cc
@jbouwh
Allow equivalent sensor units for MQTT sensor
f0906ac
@jbouwh
Include MQTT number and assert on sensor and number unit
e3ae289
@jbouwh
Add sensor recorder test cases
4e02f54
@jbouwh @emontnemery
Update pylint/plugins/hass_enforce_greek_micro_char.py
3a116ea 
Co-authored-by: Erik Montnemery <erik@montnemery.com>
@jbouwh
Update link
a49b584
@jbouwh
typo
a9e39c9
@jbouwh
Add tests
dca353c
@jbouwh
Fix recorder tests
1c4c52e
@jbouwh
Allow sensor ambiguous native_unit_of_measurement for compatibility
335621a
@jbouwh
Do not cache unit of measurement
012cea9
@jbouwh @emontnemery
Update homeassistant/components/sensor/__init__.py
6f718c2 
Co-authored-by: Erik Montnemery <erik@montnemery.com>
@jbouwh
Add unit compatibility to number entity platform
e3fe99e
@jbouwh jbouwh force-pushed the fix-microsign-alt1 branch from 0b65412 to e3fe99e Compare May 28, 2025 13:36
@jbouwh jbouwh marked this pull request as ready for review June 2, 2025 06:38
@jbouwh jbouwh requested a review from fabaff as a code owner June 2, 2025 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emontnemery emontnemery emontnemery left review comments

@Jc2k Jc2k Awaiting requested review from Jc2k Jc2k is a code owner

@Ernst79 Ernst79 Awaiting requested review from Ernst79 Ernst79 is a code owner

@raman325 raman325 Awaiting requested review from raman325 raman325 is a code owner

@joostlek joostlek Awaiting requested review from joostlek joostlek is a code owner

@bieniu bieniu Awaiting requested review from bieniu bieniu is a code owner

@bdraco bdraco Awaiting requested review from bdraco bdraco is a code owner

@Kane610 Kane610 Awaiting requested review from Kane610 Kane610 is a code owner

@thecode thecode Awaiting requested review from thecode thecode is a code owner

@fabaff fabaff Awaiting requested review from fabaff fabaff is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
cla-signed code-quality core has-tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jbouwh @MartinHjelmare @emontnemery
0