job-shop-lib 0.3.0__tar.gz → 0.4.0__tar.gz

{job_shop_lib-0.3.0 → job_shop_lib-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 0.3.0
+Version: 0.4.0
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22

{job_shop_lib-0.3.0 → job_shop_lib-0.4.0}/job_shop_lib/dispatching/dispatcher.py

@@ -7,6 +7,7 @@ from typing import Any
 from collections.abc import Callable
 from collections import deque
 from functools import wraps
+from warnings import warn
 
 from job_shop_lib import (
     JobShopInstance,
@@ -155,21 +156,13 @@ class Dispatcher:
     def create_schedule_from_raw_solution(
         cls, instance: JobShopInstance, raw_solution: list[list[Operation]]
     ) -> Schedule:
-        """Creates a schedule from a raw solution.
-
-        A raw solution is a list of lists of operations, where each list
-        represents the order of operations for a machine.
-
-        Args:
-            instance:
-                The instance of the job shop problem to be solved.
-            raw_solution:
-                A list of lists of operations, where each list represents the
-                order of operations for a machine.
-
-        Returns:
-            A Schedule object representing the solution.
-        """
+        """Deprecated method, use `Schedule.from_job_sequences` instead."""
+        warn(
+            "Dispatcher.create_schedule_from_raw_solution is deprecated. "
+            "Use Schedule.from_job_sequences instead. It will be removed in "
+            "version 1.0.0.",
+            DeprecationWarning,
+        )
         dispatcher = cls(instance)
         dispatcher.reset()
         raw_solution_deques = [

{job_shop_lib-0.3.0 → job_shop_lib-0.4.0}/job_shop_lib/operation.py

@@ -107,10 +107,10 @@ class Operation:
     def __hash__(self) -> int:
         return hash(self.operation_id)
 
-    def __eq__(self, __value: object) -> bool:
-        if isinstance(__value, Operation):
-            return self.operation_id == __value.operation_id
-        return False
+    def __eq__(self, value: object) -> bool:
+        if not isinstance(value, Operation):
+            return False
+        return self.__slots__ == value.__slots__
 
     def __repr__(self) -> str:
         machines = (

{job_shop_lib-0.3.0 → job_shop_lib-0.4.0}/job_shop_lib/schedule.py

@@ -1,6 +1,11 @@
 """Home of the `Schedule` class."""
 
-from job_shop_lib import ScheduledOperation, JobShopInstance
+from __future__ import annotations
+
+from typing import Any
+from collections import deque
+
+from job_shop_lib import ScheduledOperation, JobShopInstance, JobShopLibError
 
 
 class Schedule:
@@ -71,6 +76,96 @@ class Schedule:
         """Returns the number of operations that have been scheduled."""
         return sum(len(machine_schedule) for machine_schedule in self.schedule)
 
+    def to_dict(self) -> dict:
+        """Returns a dictionary representation of the schedule.
+
+        This representation is useful for saving the instance to a JSON file.
+
+        Returns:
+            A dictionary representation of the schedule with the following
+            keys:
+                - "instance": A dictionary representation of the instance.
+                - "job_sequences": A list of lists of job ids. Each list of job
+                    ids represents the order of operations on the machine. The
+                    machine that the list corresponds to is determined by the
+                    index of the list.
+                - "metadata": A dictionary with additional information about
+                    the schedule.
+        """
+        job_sequences: list[list[int]] = []
+        for machine_schedule in self.schedule:
+            job_sequences.append(
+                [operation.job_id for operation in machine_schedule]
+            )
+
+        return {
+            "instance": self.instance.to_dict(),
+            "job_sequences": job_sequences,
+            "metadata": self.metadata,
+        }
+
+    @staticmethod
+    def from_dict(
+        instance: dict[str, Any] | JobShopInstance,
+        job_sequences: list[list[int]],
+        metadata: dict[str, Any] | None = None,
+    ) -> Schedule:
+        """Creates a schedule from a dictionary representation."""
+        if isinstance(instance, dict):
+            instance = JobShopInstance.from_matrices(**instance)
+        schedule = Schedule.from_job_sequences(instance, job_sequences)
+        schedule.metadata = metadata if metadata is not None else {}
+        return schedule
+
+    @staticmethod
+    def from_job_sequences(
+        instance: JobShopInstance,
+        job_sequences: list[list[int]],
+    ) -> Schedule:
+        """Creates an active schedule from a list of job sequences.
+
+        An active schedule is the optimal schedule for the given job sequences.
+        In other words, it is not possible to construct another schedule,
+        through changes in the order of processing on the machines, with at
+        least one operation finishing earlier and no operation finishing later.
+
+        Args:
+            instance:
+                The `JobShopInstance` object that the schedule is for.
+            job_sequences:
+                A list of lists of job ids. Each list of job ids represents the
+                order of operations on the machine. The machine that the list
+                corresponds to is determined by the index of the list.
+
+        Returns:
+            A `Schedule` object with the given job sequences.
+        """
+        from job_shop_lib.dispatching import Dispatcher
+
+        dispatcher = Dispatcher(instance)
+        dispatcher.reset()
+        raw_solution_deques = [deque(job_ids) for job_ids in job_sequences]
+
+        while not dispatcher.schedule.is_complete():
+            at_least_one_operation_scheduled = False
+            for machine_id, job_ids in enumerate(raw_solution_deques):
+                if not job_ids:
+                    continue
+                job_id = job_ids[0]
+                operation_index = dispatcher.job_next_operation_index[job_id]
+                operation = instance.jobs[job_id][operation_index]
+                is_ready = dispatcher.is_operation_ready(operation)
+                if is_ready and machine_id in operation.machines:
+                    dispatcher.dispatch(operation, machine_id)
+                    job_ids.popleft()
+                    at_least_one_operation_scheduled = True
+
+            if not at_least_one_operation_scheduled:
+                raise JobShopLibError(
+                    "Invalid job sequences. No valid operation to schedule."
+                )
+        return dispatcher.schedule
+
     def reset(self):
         """Resets the schedule to an empty state."""
         self.schedule = [[] for _ in range(self.instance.num_machines)]

{job_shop_lib-0.3.0 → job_shop_lib-0.4.0}/job_shop_lib/scheduled_operation.py

@@ -1,6 +1,8 @@
 """Home of the `ScheduledOperation` class."""
 
-from job_shop_lib import Operation
+from warnings import warn
+
+from job_shop_lib import Operation, JobShopLibError
 
 
 class ScheduledOperation:
@@ -47,7 +49,7 @@ class ScheduledOperation:
     @machine_id.setter
     def machine_id(self, value: int):
         if value not in self.operation.machines:
-            raise ValueError(
+            raise JobShopLibError(
                 f"Operation cannot be scheduled on machine {value}. "
                 f"Valid machines are {self.operation.machines}."
             )
@@ -62,18 +64,28 @@ class ScheduledOperation:
         """
 
         if self.operation.job_id is None:
-            raise ValueError("Operation has no job_id.")
+            raise JobShopLibError("Operation has no job_id.")
         return self.operation.job_id
 
     @property
     def position(self) -> int:
+        """Deprecated. Use `position_in_job` instead."""
+        warn(
+            "The `position` attribute is deprecated. Use `position_in_job` "
+            "instead. It will be removed in version 1.0.0.",
+            DeprecationWarning,
+        )
+        return self.position_in_job
+
+    @property
+    def position_in_job(self) -> int:
         """Returns the position (starting at zero) of the operation in the job.
 
         Raises:
             ValueError: If the operation has no position_in_job.
         """
         if self.operation.position_in_job is None:
-            raise ValueError("Operation has no position.")
+            raise JobShopLibError("Operation has no position.")
         return self.operation.position_in_job
 
     @property
@@ -91,7 +103,7 @@ class ScheduledOperation:
         if not isinstance(value, ScheduledOperation):
             return False
         return (
-            self.operation is value.operation
+            self.operation == value.operation
             and self.start_time == value.start_time
             and self.machine_id == value.machine_id
         )

{job_shop_lib-0.3.0 → job_shop_lib-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "job-shop-lib"
-version = "0.3.0"
+version = "0.4.0"
 description = "An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)"
 authors = ["Pabloo22 <pablete.arino@gmail.com>"]
 license = "MIT"