sql-assignment-generator 0.0.14__tar.gz → 0.0.16__tar.gz

{sql_assignment_generator-0.0.14 → sql_assignment_generator-0.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sql_assignment_generator
-Version: 0.0.14
+Version: 0.0.16
 Summary: This project generates SQL assignments based on common mistakes made by learners.
 Project-URL: Repository, https://github.com/DavidePonzini/sql_assignment_generator
 Project-URL: Documentation, https://sql-assignment-generator.readthedocs.io/en/latest/index.html

sql_assignment_generator-0.0.16/docs/autoapi/index.rst

@@ -0,0 +1,11 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+   :titlesonly:
+
+   /autoapi/sql_assignment_generator/index
+
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

sql_assignment_generator-0.0.16/docs/autoapi/sql_assignment_generator/assignments/index.rst

@@ -0,0 +1,173 @@
+sql_assignment_generator.assignments
+====================================
+
+.. py:module:: sql_assignment_generator.assignments
+
+.. autoapi-nested-parse::
+
+   Data structures for SQL assignments.
+
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   sql_assignment_generator.assignments.Assignment
+   sql_assignment_generator.assignments.Exercise
+   sql_assignment_generator.assignments.Dataset
+
+
+Package Contents
+----------------
+
+.. py:class:: Assignment
+
+   A full SQL assignment consisting of a dataset and exercises.
+
+
+   .. py:attribute:: dataset
+      :type:  sql_assignment_generator.assignments.dataset.Dataset
+
+      The dataset associated with the assignment.
+
+
+
+   .. py:attribute:: exercises
+      :type:  list[sql_assignment_generator.assignments.exercise.Exercise]
+
+      The exercises included in the assignment.
+
+
+
+.. py:class:: Exercise
+
+   A SQL exercise consisting of a title, request, and solutions.
+
+
+   .. py:attribute:: title
+      :type:  str
+
+      The title of the exercise.
+
+
+
+   .. py:attribute:: request
+      :type:  str
+
+      The natural language request or question for the exercise.
+
+
+
+   .. py:attribute:: solutions
+      :type:  list[sqlscope.Query]
+
+      The list of SQL query solutions for the exercise.
+
+
+
+   .. py:attribute:: difficulty
+      :type:  sql_assignment_generator.difficulty_level.DifficultyLevel
+
+      The difficulty level of the exercise.
+
+
+
+   .. py:attribute:: error
+      :type:  sql_error_taxonomy.SqlErrors
+
+      The SQL error type associated with the exercise.
+
+
+
+   .. py:method:: generate(error, difficulty, constraints, *, extra_details, dataset, title, sql_dialect, language, max_attempts = 3)
+      :staticmethod:
+
+
+      Generate a SQL exercise based on the specified parameters.
+
+
+
+.. py:class:: Dataset
+
+   A SQL dataset related to a specific domain, including schema creation and data insertion commands.
+
+
+   .. py:attribute:: create_commands
+      :type:  list[str]
+
+      SQL commands to create the database schema.
+
+
+
+   .. py:attribute:: insert_commands
+      :type:  list[str]
+
+      SQL commands to insert data into the database.
+
+
+
+   .. py:attribute:: domain
+      :type:  str
+
+      The domain associated with the dataset.
+
+
+
+   .. py:attribute:: _catalog_cache
+      :type:  sqlscope.Catalog | None
+      :value: None
+
+
+      Cached SQLScope Catalog for the dataset.
+
+
+
+   .. py:attribute:: _catalog_cache_commands_hash
+      :type:  int | None
+      :value: None
+
+
+      Hash of the CREATE TABLE commands used to build the cached Catalog.
+
+
+
+   .. py:property:: catalog
+      :type: sqlscope.Catalog
+
+
+      Build and return a SQLScope Catalog from the dataset's SQL commands.
+      The result is cached for handling multiple accesses efficiently.
+      Cache is properly invalidated if the CREATE TABLE commands change.
+
+
+
+   .. py:method:: to_sql_no_context()
+
+      Generate the SQL commands to create and populate the dataset without schema context.
+
+
+
+   .. py:method:: to_sql(schema)
+
+      Generate the SQL commands to create and populate the dataset within the specified schema.
+
+
+
+   .. py:method:: from_sql(sql_str, sql_dialect)
+      :staticmethod:
+
+
+      Create a Dataset instance from a raw SQL string containing CREATE TABLE and INSERT INTO commands.
+
+
+
+   .. py:method:: generate(domain, sql_dialect, constraints, extra_details = [], *, language, max_attempts = 5)
+      :staticmethod:
+
+
+      Generate a SQL dataset based on the specified parameters.
+
+
+

sql_assignment_generator-0.0.16/docs/autoapi/sql_assignment_generator/constraints/index.rst

@@ -0,0 +1,104 @@
+sql_assignment_generator.constraints
+====================================
+
+.. py:module:: sql_assignment_generator.constraints
+
+.. autoapi-nested-parse::
+
+   Constraints for assignment generation.
+
+
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   /autoapi/sql_assignment_generator/constraints/query/index
+   /autoapi/sql_assignment_generator/constraints/schema/index
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   sql_assignment_generator.constraints.BaseConstraint
+   sql_assignment_generator.constraints.QueryConstraint
+   sql_assignment_generator.constraints.SchemaConstraint
+
+
+Package Contents
+----------------
+
+.. py:class:: BaseConstraint
+
+   Bases: :py:obj:`abc.ABC`
+
+
+   Abstract base class for SQL query constraints.
+
+
+   .. py:property:: description
+      :type: sql_assignment_generator.translatable_text.TranslatableText
+
+      :abstractmethod:
+
+
+      Textual description of the constraint, to be used in prompts.
+
+
+
+.. py:class:: QueryConstraint
+
+   Bases: :py:obj:`sql_assignment_generator.constraints.base.BaseConstraint`
+
+
+   Base class for query-related constraints.
+
+
+   .. py:method:: validate(query)
+      :abstractmethod:
+
+
+      Validate if the given SQL query satisfies the constraint.
+
+      Args:
+          query (Query): The SQL query to validate.
+      Raises:
+          ConstraintValidationError: If the query does not satisfy the constraint.
+
+
+
+.. py:class:: SchemaConstraint
+
+   Bases: :py:obj:`sql_assignment_generator.constraints.base.BaseConstraint`
+
+
+   Base class for schema-related constraints.
+
+
+   .. py:method:: validate(catalog, tables_sql, values_sql)
+      :abstractmethod:
+
+
+      Validate if the given table creation and insertion statements satisfy the constraint.
+
+      Args:
+          catalog (Catalog): The catalog representing the database schema.
+          tables_sql (list[exp.Create]): List of CREATE TABLE expressions.
+          values_sql (list[exp.Insert]): List of INSERT INTO expressions.
+      Raises:
+          ConstraintValidationError: If the schema does not satisfy the constraint.
+
+
+
+   .. py:method:: merge(other)
+      :abstractmethod:
+
+
+      Merges this constraint with another constraint of the same type.
+
+
+

sql_assignment_generator-0.0.16/docs/autoapi/sql_assignment_generator/constraints/query/index.rst

@@ -0,0 +1,43 @@
+sql_assignment_generator.constraints.query
+==========================================
+
+.. py:module:: sql_assignment_generator.constraints.query
+
+.. autoapi-nested-parse::
+
+   Constraints related to SQL queries.
+
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   sql_assignment_generator.constraints.query.QueryConstraint
+
+
+Package Contents
+----------------
+
+.. py:class:: QueryConstraint
+
+   Bases: :py:obj:`sql_assignment_generator.constraints.base.BaseConstraint`
+
+
+   Base class for query-related constraints.
+
+
+   .. py:method:: validate(query)
+      :abstractmethod:
+
+
+      Validate if the given SQL query satisfies the constraint.
+
+      Args:
+          query (Query): The SQL query to validate.
+      Raises:
+          ConstraintValidationError: If the query does not satisfy the constraint.
+
+
+

sql_assignment_generator-0.0.16/docs/autoapi/sql_assignment_generator/constraints/schema/index.rst

@@ -0,0 +1,66 @@
+sql_assignment_generator.constraints.schema
+===========================================
+
+.. py:module:: sql_assignment_generator.constraints.schema
+
+.. autoapi-nested-parse::
+
+   Constraints related to database schema.
+
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   sql_assignment_generator.constraints.schema.SchemaConstraint
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   sql_assignment_generator.constraints.schema.merge_constraints
+
+
+Package Contents
+----------------
+
+.. py:class:: SchemaConstraint
+
+   Bases: :py:obj:`sql_assignment_generator.constraints.base.BaseConstraint`
+
+
+   Base class for schema-related constraints.
+
+
+   .. py:method:: validate(catalog, tables_sql, values_sql)
+      :abstractmethod:
+
+
+      Validate if the given table creation and insertion statements satisfy the constraint.
+
+      Args:
+          catalog (Catalog): The catalog representing the database schema.
+          tables_sql (list[exp.Create]): List of CREATE TABLE expressions.
+          values_sql (list[exp.Insert]): List of INSERT INTO expressions.
+      Raises:
+          ConstraintValidationError: If the schema does not satisfy the constraint.
+
+
+
+   .. py:method:: merge(other)
+      :abstractmethod:
+
+
+      Merges this constraint with another constraint of the same type.
+
+
+
+.. py:function:: merge_constraints(constraints)
+
+   Merge similar schema constraints into a single set of constraints.
+
+