Skip to content
Merged
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
6 changes: 3 additions & 3 deletions docs/regression_test_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,9 @@ Environments and Systems
:members:
:show-inheritance:

-------------------------------------
Job Schedulers and Parallel Launchers
-------------------------------------
---------------------------
Jobs and Parallel Launchers
---------------------------

.. automodule:: reframe.core.schedulers
:members:
Expand Down
22 changes: 21 additions & 1 deletion reframe/core/schedulers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@


class JobMeta(RegressionTestMeta, abc.ABCMeta):
'''Job metaclass.'''
'''Job metaclass.

:meta private:
'''


class JobSchedulerMeta(abc.ABCMeta):
Expand Down Expand Up @@ -354,34 +357,45 @@ def create(cls, scheduler, launcher, *args, **kwargs):

@property
def name(self):
'''The name of this job.'''
return self._name

@property
def workdir(self):
'''The working directory for this job.'''
return self._workdir

@property
def cli_options(self):
'''The scheduler options passed through the :option:`-J` command line
options.'''
return self._cli_options

@property
def script_filename(self):
'''The filename of the generated job script.'''
return self._script_filename

@property
def stdout(self):
'''The file where the standard output of the job is saved.'''
return self._stdout

@property
def stderr(self):
'''The file where the standard error of the job is saved.'''
return self._stderr

@property
def sched_flex_alloc_nodes(self):
'''The argument of the :option:`--flex-alloc-nodes` command line
option.'''
return self._sched_flex_alloc_nodes

@property
def sched_access(self):
'''The partition's :attr:`~config.systems.partitions.access`
options.'''
return self._sched_access

@property
Expand All @@ -408,10 +422,16 @@ def completion_time(self):

@property
def scheduler(self):
'''The scheduler where this job is assigned to.'''
return self._scheduler

@property
def exception(self):
'''The last exception that this job encountered.

The scheduler will raise this exception the next time the status of
this job is queried.
'''
return self._exception

@property
Expand Down