Skip to content
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.

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

Add support for Todoist sections #115671

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

cmbuckley
Copy link

@cmbuckley cmbuckley commented Apr 15, 2024

Proposed change

Adds support for project sections in the Todoist integration, specifically the todoist.new_task service.

The section is optional. If it is not provided, the task will be added to the project as before. If the section is provided, it must be a name of an existing section within the given project. As with providing an incorrect project name, this will raise an error if the named section does not exist in the project.

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

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @cmbuckley

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft April 15, 2024 23:59
@home-assistant
Copy link

Hey there @boralyl, mind taking a look at this pull request as it has been labeled with an integration (todoist) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of todoist can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign todoist Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@cmbuckley cmbuckley marked this pull request as ready for review April 16, 2024 00:02
Copy link
Contributor

@boralyl boralyl left a comment

Choose a reason for hiding this comment

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

Thanks for the submission! Tested this out and looked over the code and looks good.

cmbuckley added a commit to cmbuckley/home-assistant.io that referenced this pull request Apr 16, 2024
cmbuckley added a commit to cmbuckley/home-assistant.io that referenced this pull request Apr 16, 2024
@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label May 25, 2024
@emontnemery emontnemery reopened this May 28, 2024
@emontnemery
Copy link
Contributor

(Close + open to retrigger stuck CI)

# Optional section within project
section_id: str | None = None
if SECTION_NAME in call.data:
section_name = call.data[SECTION_NAME].lower()
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we call lower here, isn't lower case already guaranteed by the schema?
I think we should also, in a separate PR, remove the call to lower for the project name above.

sections = await coordinator.async_get_sections(project_id)
for section in sections:
if section_name == section.name.lower():
section_id = section.id
Copy link
Contributor

Choose a reason for hiding this comment

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

Also break out of the for loop when handling the project name above

Suggested change
section_id = section.id
section_id = section.id
break

if section_name == section.name.lower():
section_id = section.id
if section_id is None:
raise HomeAssistantError(
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be a ServiceValidationError, with translation in strings.json. Same for the project name error.

@home-assistant home-assistant bot marked this pull request as draft May 28, 2024 10:30
@frenck frenck removed the smash Indicator this PR is close to finish for merging or closing label May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants