Skip to content

[cmd] ScheduleCommand decorators and methods fix #74

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions commands2/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,23 @@
"""
return SelectCommand(commands, selector)

def fork(
*commands: Command
) -> Command:
"""
Create a command to run "forked" by wrapping the provided commands in a ScheduleCommand. Use this for
"forking off" from command compositions when the user does not wish to extend the command's
requirements to the entire command composition. Note that if run from a composition, the
composition will not know about the status of the scheduled commands, and will treat this
command as finishing instantly. Multiple commmands can be added to this and will be schedule in order.,
see the `WPILib docs <https://docs.wpilib.org/en/stable/docs/software/commandbased/command-compositions.html#scheduling-other-commands>`_ for a full explanation.

:param commands: commands to schedule in order
:returns: the command
"""
from .schedulecommand import ScheduleCommand
return ScheduleCommand(commands)

Check failure on line 183 in commands2/cmd.py

View workflow job for this annotation

GitHub Actions / check-mypy

Argument 1 to "ScheduleCommand" has incompatible type "tuple[Command, ...]"; expected "Command"


def sequence(*commands: Command) -> Command:
"""
Expand Down
8 changes: 4 additions & 4 deletions commands2/command.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
from .parallelcommandgroup import ParallelCommandGroup
from .repeatcommand import RepeatCommand
from .proxycommand import ProxyCommand
from .schedulecommand import ScheduleCommand
from .conditionalcommand import ConditionalCommand
from .wrappercommand import WrapperCommand

Expand Down Expand Up @@ -384,21 +385,20 @@ def asProxy(self) -> ProxyCommand:

return ProxyCommand(self)

def fork(self, *commands: Command) -> ProxyCommand:
def fork(self, *commands: Command) -> ScheduleCommand:
"""
Decorates this command to run "forked" by wrapping it in a ScheduleCommand. Use this for
"forking off" from command compositions when the user does not wish to extend the command's
requirements to the entire command composition. Note that if run from a composition, the
composition will not know about the status of the scheduled commands, and will treat this
command as finishing instantly. Commands can be added to this and will be scheduled in order
with this command scheduled first., see the `WPILib docs <https://docs.wpilib.org/en/stable/docs/software/commandbased/command-compositions.html#scheduling-other-commands>`_ for a full explanation.
command as finishing instantly., see the `WPILib docs <https://docs.wpilib.org/en/stable/docs/software/commandbased/command-compositions.html#scheduling-other-commands>`_ for a full explanation.

:param other: other commands to schedule along with this one. This command is scheduled first.
:returns: the decorated command
"""
from .schedulecommand import ScheduleCommand

return ScheduleCommand(self, [self] + commands)
return ScheduleCommand(self)

def unless(self, condition: Callable[[], bool]) -> ConditionalCommand:
"""
Expand Down
Loading