studio/flamenco
studio/flamenco
12
30
Fork 38
Code Issues 62 Pull Requests 8 Releases Wiki Activity

Add-on: Add checkbox to submit jobs in paused status #104323

Merged
David Zhang merged 1 commits from David-Zhang-10/flamenco:submit-as-paused-addon into main 2024-07-25 04:26:06 +02:00
Conversation 0 Commits 1 Files Changed 3 +15
3 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
addon/flamenco/__init__.py
View File

@ -156,6 +156,12 @@ def register() -> None:
max=100,
)
bpy.types.Scene.flamenco_job_submit_as_paused = bpy.props.BoolProperty(
David-Zhang-10 marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2024-07-15 11:12:42 +02:00
Outdated
Review
Copy Link

There's a discrepancy here between the property name (says this should be a status) and its definition (says it's whether the job should be paused or not). Choose one, and use it consistently.

Since this property is used for the GUI as well, and we discussed offering a checkbox 'submit paused', using a BoolProperty is the right choice, and the name should change.

There's a discrepancy here between the property name (says this should be a status) and its definition (says it's whether the job should be paused or not). Choose one, and use it consistently. Since this property is used for the GUI as well, and we discussed offering a checkbox 'submit paused', using a `BoolProperty` is the right choice, and the name should change.
name="Flamenco Job Submit as Paused",
description="Whether the job is paused initially; Checked sets the job to `paused`, and Unchecked sets the job to `queued`",
David-Zhang-10 marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2024-07-15 11:16:41 +02:00
Outdated
Review
Copy Link

This description is for users of Blender, not for developers. Replace the Python terminology (True and False) with what they can see: checked & unchecked.

👍 for describing both 'checked' & 'unchecked' cases, often enough people only describe one and leave you to guess what the other meant. My favourite example here is good old DOOM: it had a checkbox "8-bit textures" -- no idea whether un-checking meant 4-bit or 16-bit textures.

This description is for users of Blender, not for developers. Replace the Python terminology (`True` and `False`) with what they can see: checked & unchecked. 👍 for describing both 'checked' & 'unchecked' cases, often enough people only describe one and leave you to guess what the other meant. My favourite example here is good old DOOM: it had a checkbox "8-bit textures" -- no idea whether un-checking meant 4-bit or 16-bit textures.
default=False,
)
preferences.register()
worker_tags.register()
operators.register()

1
addon/flamenco/gui.py
View File

@ -42,6 +42,7 @@ class FLAMENCO_PT_job_submission(bpy.types.Panel):
col = layout.column(align=True)
col.prop(context.scene, "flamenco_job_name", text="Job Name")
col.prop(context.scene, "flamenco_job_priority", text="Priority")
col.prop(context.scene, "flamenco_job_submit_as_paused", text="Submit as Paused")
David-Zhang-10 marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2024-07-22 11:14:00 +02:00
Outdated
Review
Copy Link

Make sure you test before committing & pushing ;-) (and yes, I've been here myself as well)

Make sure you test before committing & pushing ;-) (and yes, I've been here myself as well)
# Refreshables:
col = layout.column(align=True)

8
addon/flamenco/job_submission.py
View File

@ -33,6 +33,7 @@ log = logging.getLogger(__name__)
def job_for_scene(scene: bpy.types.Scene) -> Optional[_SubmittedJob]:
from flamenco.manager.models import SubmittedJob, JobMetadata
from flamenco.manager.model.job_status import JobStatus
propgroup = getattr(scene, "flamenco_job_settings", None)
assert isinstance(propgroup, JobTypePropertyGroup), "did not expect %s" % (
@ -44,6 +45,12 @@ def job_for_scene(scene: bpy.types.Scene) -> Optional[_SubmittedJob]:
priority = getattr(scene, "flamenco_job_priority", 50)
submit_as_paused = getattr(scene, "flamenco_job_submit_as_paused", False)
if submit_as_paused:
initial_status = JobStatus("paused")
else:
initial_status = JobStatus("queued")
job: SubmittedJob = SubmittedJob(
name=scene.flamenco_job_name,
type=propgroup.job_type.name,
@ -52,6 +59,7 @@ def job_for_scene(scene: bpy.types.Scene) -> Optional[_SubmittedJob]:
metadata=metadata,
submitter_platform=platform.system().lower(),
type_etag=propgroup.job_type.etag,
initial_status=initial_status,
)
worker_tag: str = getattr(scene, "flamenco_worker_tag", "")