home-assistant/core
1
0
Fork 1
mirror of https://github.com/home-assistant/core.git synced 2025-09-06 21:31:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Paperless-ngx: Disable entities by default and extended docs (#149473)

Browse Source
This commit is contained in:
Florian von Garrel
2025-08-10 23:36:36 +02:00
committed by GitHub
parent 84de6aacfc
commit 7b5dd4a0ec
3 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
homeassistant/components/paperless_ngx/quality_scale.yaml
View File

@@ -50,19 +50,19 @@ rules:
discovery: discovery:
status: exempt status: exempt
comment: Paperless does not support discovery. comment: Paperless does not support discovery.
docs-data-update: todo docs-data-update: done
docs-examples: todo docs-examples: done
docs-known-limitations: todo docs-known-limitations: done
docs-supported-devices: todo docs-supported-devices: done
docs-supported-functions: todo docs-supported-functions: done
docs-troubleshooting: todo docs-troubleshooting: done
docs-use-cases: todo docs-use-cases: done
dynamic-devices: dynamic-devices:
status: exempt status: exempt
comment: Service type integration comment: Service type integration
entity-category: done entity-category: done
entity-device-class: done entity-device-class: done
entity-disabled-by-default: todo entity-disabled-by-default: done
entity-translations: done entity-translations: done
exception-translations: done exception-translations: done
icon-translations: done icon-translations: done

7
homeassistant/components/paperless_ngx/sensor.py
View File

@@ -56,24 +56,28 @@ SENSOR_STATISTICS: tuple[PaperlessEntityDescription[Statistic], ...] = (
translation_key="characters_count", translation_key="characters_count",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value_fn=lambda data: data.character_count, value_fn=lambda data: data.character_count,
entity_registry_enabled_default=False,
), ),
PaperlessEntityDescription[Statistic]( PaperlessEntityDescription[Statistic](
key="tag_count", key="tag_count",
translation_key="tag_count", translation_key="tag_count",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value_fn=lambda data: data.tag_count, value_fn=lambda data: data.tag_count,
entity_registry_enabled_default=False,
), ),
PaperlessEntityDescription[Statistic]( PaperlessEntityDescription[Statistic](
key="correspondent_count", key="correspondent_count",
translation_key="correspondent_count", translation_key="correspondent_count",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value_fn=lambda data: data.correspondent_count, value_fn=lambda data: data.correspondent_count,
entity_registry_enabled_default=False,
), ),
PaperlessEntityDescription[Statistic]( PaperlessEntityDescription[Statistic](
key="document_type_count", key="document_type_count",
translation_key="document_type_count", translation_key="document_type_count",
state_class=SensorStateClass.MEASUREMENT, state_class=SensorStateClass.MEASUREMENT,
value_fn=lambda data: data.document_type_count, value_fn=lambda data: data.document_type_count,
entity_registry_enabled_default=False,
), ),
) )
@@ -141,6 +145,7 @@ SENSOR_STATUS: tuple[PaperlessEntityDescription[Status], ...] = (
translation_key="index_status", translation_key="index_status",
device_class=SensorDeviceClass.ENUM, device_class=SensorDeviceClass.ENUM,
entity_category=EntityCategory.DIAGNOSTIC, entity_category=EntityCategory.DIAGNOSTIC,
entity_registry_enabled_default=False,
options=[ options=[
item.value.lower() for item in StatusType if item != StatusType.UNKNOWN item.value.lower() for item in StatusType if item != StatusType.UNKNOWN
], ],
@@ -159,6 +164,7 @@ SENSOR_STATUS: tuple[PaperlessEntityDescription[Status], ...] = (
translation_key="classifier_status", translation_key="classifier_status",
device_class=SensorDeviceClass.ENUM, device_class=SensorDeviceClass.ENUM,
entity_category=EntityCategory.DIAGNOSTIC, entity_category=EntityCategory.DIAGNOSTIC,
entity_registry_enabled_default=False,
options=[ options=[
item.value.lower() for item in StatusType if item != StatusType.UNKNOWN item.value.lower() for item in StatusType if item != StatusType.UNKNOWN
], ],
@@ -177,6 +183,7 @@ SENSOR_STATUS: tuple[PaperlessEntityDescription[Status], ...] = (
translation_key="celery_status", translation_key="celery_status",
device_class=SensorDeviceClass.ENUM, device_class=SensorDeviceClass.ENUM,
entity_category=EntityCategory.DIAGNOSTIC, entity_category=EntityCategory.DIAGNOSTIC,
entity_registry_enabled_default=False,
options=[ options=[
item.value.lower() for item in StatusType if item != StatusType.UNKNOWN item.value.lower() for item in StatusType if item != StatusType.UNKNOWN
], ],

1
tests/components/paperless_ngx/test_sensor.py
View File

@@ -29,6 +29,7 @@ from tests.common import (
) )
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
async def test_sensor_platform( async def test_sensor_platform(
hass: HomeAssistant, hass: HomeAssistant,
mock_config_entry: MockConfigEntry, mock_config_entry: MockConfigEntry,