PluginMeta Model

PluginMeta model for defining the selection strategy and search terms for Smarter plugins.

class smarter.apps.plugin.models.plugin_meta.PluginMeta(*args, **kwargs)[source]

Bases: MetaDataWithOwnershipModel, SmarterHelperMixin

Represents the core metadata for a Smarter plugin, serving as the central registry for all plugin types.

This class defines the essential identifying and descriptive information for a plugin, including its name, description, type (static, SQL, or API), version, user_profile, and associated tags. Each plugin is uniquely associated with an account and a user_profile, ensuring that plugin names are unique per account and enforcing a snake_case naming convention for consistency and compatibility.

The PluginMeta model acts as the anchor point for related plugin configuration and data models, such as PluginDataStatic, PluginDataSql, and PluginDataApi, which store the specific data and behavior for each plugin type. It is also linked to selection and prompt configuration through PluginSelector and PluginPrompt, enabling flexible plugin discovery and LLM prompt customization.

Validation logic within this class ensures that plugin names conform to required standards, and class methods provide efficient, cached access to plugin instances for a given user or account.

This model is foundational for the Smarter plugin system, enabling the organization, discovery, and management of all plugins within an account, and supporting integration with the broader plugin data and connection models defined in this module.

Parameters:

id (Unknown) – Primary key: ID
created_at (Unknown) – Created at
updated_at (Unknown) – Updated at
name (Unknown) – Name. Name in camelCase, e.g., ‘apiKey’, no special characters.
description (Unknown) – Description. A brief description of this resource. Be verbose, but not too verbose.
version (Unknown) – Version. Semantic version in the format MAJOR.MINOR.PATCH, e.g., ‘1.0.0’.
annotations (Unknown) – Annotations. Key-value pairs for annotating this resource.
plugin_class (Unknown) – Plugin class. The class name of the plugin

Relationship fields:

Parameters:

user_profile (Unknown) – User profile (related name: pluginmeta)
tags (Unknown) – Tags. Tags for categorizing and organizing this resource. (related name: pluginmeta)
tagged_items (Unknown) – Tagged items (related name: +)

Reverse relationships:

Parameters:

llmclientplugin (Unknown) – All LLMClient Plugins of this Plugin (related name of plugin_meta)
plugin_data_base_plugin (Unknown) – The plugin data base plugin of this Plugin (related name of plugin)
plugin_prompt_plugin (Unknown) – The plugin prompt plugin of this Plugin (related name of plugin)
plugin_selector_plugin (Unknown) – The plugin selector plugin of this Plugin (related name of plugin)
promptpluginusage (Unknown) – All Prompt Plugin Usage of this Plugin (related name of plugin)
prompttoolcall (Unknown) – All Prompt Tool Call History of this Plugin (related name of plugin)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note(object, /): Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback(object, /): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

HASH_FLOOR = 1000000

HASH_PREFIX = 'r'

HASH_SUFFIX = 'x'

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note(object, /): Exception.add_note(note) – add a note to the exception

args

with_traceback(object, /): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

__init__(*args, **kwargs)

add_note(object, /): Exception.add_note(note) – add a note to the exception

args

with_traceback(object, /): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

PLUGIN_CLASSES = [('static', 'static'), ('sql', 'sql'), ('api', 'api')]: The classes of plugins supported by Smarter.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

property amnesty_urls: list[str]

Returns a list of URLs that are exempt from certain checks.

Returns:: List of URL path strings that are exempt.
Return type:: list[str]

annotations

JSONField

Annotations. Key-value pairs for annotating this resource.

Type:: Type

async arefresh_from_db(using=None, fields=None, from_queryset=None)

async asave(*, force_insert=False, force_update=False, using=None, update_fields=None)

bool_environment_variable(var_name, default=False)

Retrieves a boolean value from an environment variable.

This method checks the specified environment variable and returns its value as a boolean. It recognizes common truthy values such as “true”, “1”, “yes”, and “on”. If the variable is not set or cannot be interpreted as a boolean, it returns the provided default value.

Parameters:

var_name (str) – The name of the environment variable to check.
default (bool) – The default boolean value to return if the environment variable is not set or invalid.

Returns:

The boolean value of the environment variable or the default.

Return type:

bool

cache_expiration = 60

classmethod check(**kwargs)

clean(): Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None): Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

clone(new_name=None, new_version=None, user_profile=None)

Create a clone of this instance with a new name, version, and/or user profile.

Parameters:

new_name (Optional[str]) – The name for the cloned instance. If not provided, the original name will be suffixed with “ (clone)”.
new_version (Optional[str]) – The version for the cloned instance. If not provided, the original version will be used.
user_profile (Optional[UserProfile]) – The user profile for the cloned instance. If not provided, the original user profile will be used.

Returns:

A new instance of MetaDataWithOwnershipModel that is a clone of this instance with the specified changes.

Return type:

MetaDataWithOwnershipModel

created_at

DateTimeField

Created at

Timestamp indicating when the model instance was created.

This field is automatically set to the current date and time when the instance is first created. It is indexed in the database for efficient querying.

Type:: Type

data_to_dict(data)

Converts data to a dictionary, handling different types of input.

This method accepts either a dictionary or a string. If a string is provided, it will attempt to parse it as JSON first, and if that fails, as YAML. If parsing fails or the data type is unsupported, a SmarterValueError is raised.

Parameters:: data (Union[dict, str]) – The data to convert, either a dict or a JSON/YAML string.
Returns:: The data as a dictionary.
Return type:: dict
Raises:: SmarterValueError – If the data cannot be converted to a dictionary.

date_error_message(lookup_type, field_name, unique_for)

delete(using=None, keep_parents=False)

description

TextField

Description. A brief description of this resource. Be verbose, but not too verbose.

Type:: Type

deserves_amnesty(slug)

Determines if a given URL deserves amnesty based on the amnesty URLs list.

This excuses certain endpoints (like health checks) from select middleware checks.

Parameters:: slug (str) – The URL path to check.
Returns:: True if the URL deserves amnesty, False otherwise.
Return type:: bool

dict_is_contained_in(dict1, dict2)

Checks if one dictionary is contained within another.

This method determines if all key-value pairs in dict1 are present in dict2.

Parameters:

dict1 (dict) – The dictionary to check for containment.
dict2 (dict) – The dictionary to check against for containment.

Returns:

True if dict1 is contained in dict2, False otherwise.

Return type:

bool

dict_is_subset(small, big)

Checks if one dictionary is a subset of another.

This method determines if all key-value pairs in the small dictionary are present in the big dictionary. It returns True if the small dictionary is a subset of the big dictionary, and False otherwise.

Parameters:

small (dict) – The dictionary to check as a subset.
big (dict) – The dictionary to check against as a superset.

Returns:

True if the small dictionary is a subset of the big dictionary, False otherwise.

Return type:

bool

property elapsed_updated: int | None

Calculate the absolute time difference in seconds between a given datetime and the model’s updated_at timestamp.

This property is useful for determining how much time has elapsed since the model instance was last updated, or for comparing the updated_at field to any arbitrary datetime.

Parameters:

dt (datetime, optional): The reference datetime to compare against updated_at. - If dt is not provided, the current time is used. - Both naive and timezone-aware datetime objects are supported; the method will handle conversions as needed.

Returns:

int or None: The absolute difference in seconds between updated_at and dt. Returns None if updated_at is not set.

Example Usage:

obj = MyModel.objects.get(pk=1)
# Time since last update
seconds = obj.elapsed_updated
print(f"Seconds since last update: {seconds}")

# Compare to a specific datetime
import datetime
dt = datetime.datetime(2025, 12, 1, 12, 0, 0)
diff = obj.elapsed_updated(dt)
print(f"Seconds between updated_at and 2025-12-01 12:00:00: {diff}")

Note

Handles both naive and aware datetime objects, converting as necessary to ensure accurate calculation.
If updated_at is not set (e.g., the object has not been saved), returns None.

Attention

If dt is provided and is not a datetime.datetime instance, a TypeError will be raised.
Always ensure that updated_at is set before relying on this property for calculations.

classmethod find_hash(value)

Finds and returns the first substring in the given value that matches.

the hashed ID format.

Parameters:: value (str) – The string to search for a hashed ID.
Returns:: The first matching hashed ID if found, otherwise None.
Return type:: Optional[str]

property formatted_class_name: str

Returns the class name formatted for logging.

Returns:: The formatted class name as a string.
Return type:: str

formatted_json(json_obj)

Formats a JSON object as a pretty-printed string with ANSI color codes for logging.

Parameters:: json_obj (Union[dict, list]) – The JSON object (dict or list) to format.
Returns:: A string representation of the JSON object with ANSI color codes.
Return type:: str

property formatted_state_not_ready: str

Returns the not-ready state formatted for logging.

Returns:: The formatted not-ready state as a string.
Return type:: str

property formatted_state_ready: str

Returns the readiness state formatted for logging.

Returns:: The formatted readiness state as a string.
Return type:: str

formatted_text(text, color_code='\\x1b[1;31m')

Formats text with ANSI color codes for logging.

Parameters:

text (str) – The text to format.
color_code (str) – The ANSI color code to apply.

Returns:

The formatted text with ANSI color codes.

Return type:

str

formatted_text_blue(text)

Formats text in bold dark blue for logging.

Parameters:: text (str) – The text to format.
Returns:: The formatted text in bold dark blue.
Return type:: str

formatted_text_green(text)

Formats text in bright green for logging.

Parameters:: text (str) – The text to format.
Returns:: The formatted text in bright green.
Return type:: str

formatted_text_red(text)

Formats text in dark red for logging.

Parameters:: text (str) – The text to format.
Returns:: The formatted text in dark red.
Return type:: str

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True): Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

generate_fernet_encryption_key()

Generates a Fernet encryption key.

This method creates a new Fernet encryption key, which can be used for secure encryption and decryption of data. The generated key is returned as a URL-safe base64-encoded string.

Returns:: A new Fernet encryption key.
Return type:: str

classmethod get_cached_object(*args, invalidate=False, pk=None, name=None, user=None, user_profile=None, username=None, account=None, plugin_class=None, **kwargs)[source]

Return a single instance of PluginMeta by primary key or by name and user.

This method caches the results to improve performance.

Parameters:

name (Optional[str]) – The name of the plugin to retrieve.
user (Optional[User]) – The user who owns the plugin.
account (Optional[Account]) – The account associated with the plugin.
username (Optional[str]) – The username of the user who owns the plugin.
invalidate (Optional[bool]) – If True, invalidate the cache for this query.

Returns:

A PluginMeta instance if found, otherwise None.

Return type:

Optional[PluginMeta]

classmethod get_cached_objects(invalidate=False, user_profile=None)[source]

Return a QuerySet of all PluginMeta instances for the given user profile.

This method caches the results to improve performance.

Parameters:

invalidate (Optional[bool]) – If True, invalidate the cache for this query.
user_profile (Optional[UserProfile]) – The user profile whose plugins should be retrieved.

Returns:

A QuerySet of PluginMeta instances for the user profile.

Return type:

QuerySet

classmethod get_cached_plugins_for_user_profile_id(invalidate=False, user_profile_id=None)[source]

Return a list of all instances of PluginMeta for the given user.

This method caches the results to improve performance.

Parameters:

user_profile_id (Optional[int]) – The ID of the user profile whose plugins should be retrieved.
invalidate (Optional[bool]) – Whether to invalidate the cache before retrieving the plugins.

Returns:

A list of PluginMeta instances for the user profile.

Return type:

list[PluginMeta]

See also:

smarter.lib.cache.cache_results()

get_constraints()

get_deferred_fields(): Return a set containing names of deferred fields for this instance.

classmethod get_object_by_locator(locator)

Retrieves an object based on its record locator.

Example:

obj = MyModel.objects.create()
print(obj.id)  # e.g., 123
locator = obj.record_locator # e.g., "mymodel-rc2x"

retrieved_obj = MyModel.get_object_by_locator(locator)
print(type(retrieved_obj))  # Should be <class 'MyModel'>
print(retrieved_obj)  # Should be the same as obj

Parameters:: locator (str) – The record locator string to decode and search for.
Returns:: The model instance if found, otherwise None.
Return type:: Optional[TimestampedModel]

get_plugin_class_display(*, field=<django.db.models.CharField: plugin_class>): Shows the label of the plugin_class. See get_FOO_display() for more information.

get_readonly_csv_file(file_path)

Retrieves a read-only file object for a CSV file.

This method opens the specified CSV file in read-only mode and returns a file object that can be used to read its contents. It ensures that the file is not modified during the reading process.

Parameters:: file_path (str) – The path to the CSV file to open.
Returns:: A read-only file object for the specified CSV file.
Return type:: file

get_readonly_yaml_file(file_path)

Retrieves a read-only file object for a YAML file.

This method opens the specified YAML file in read-only mode and returns a file object that can be used to read its contents. It ensures that the file is not modified during the reading process.

Parameters:: file_path (str) – The path to the YAML file to open.
Returns:: A read-only file object for the specified YAML file.
Return type:: file

classmethod hash_regex()

Returns a regex pattern that matches the hashed ID format for this model anywhere in a string.

The hashed ID format is defined by the HASH_PREFIX and HASH_SUFFIX class attributes, with a base64-encoded string in between. This regex can be used to validate or extract hashed IDs from strings, including when embedded in URLs.

Returns:: A regex pattern for matching hashed IDs.
Return type:: Pattern

property hashed_id: str

Returns a URL-friendly hashed version of the object’s ID for use in URLs and other.

contexts where an obscured, non-identifying, non-sequential identifier is preferred.

Encoding scheme: 1. Take the object’s ID and add a large constant (HASH_FLOOR) to ensure it’s not easily guessable. 2. Convert the resulting number to a string and encode it using URL-safe base64 encoding. 3. Remove any padding characters from the encoded string. 4. Add a prefix and suffix to the encoded string to create a recognizable format.

Example:

obj = MyModel.objects.create()
print(obj.id)  # e.g., 123
print(obj.hashed_id)  # e.g., "rc2x"

Returns:: Hashed ID string (URL-safe, no padding)
Return type:: str

property health_check_urls: list[str]

Returns a list of URL paths that are considered health check endpoints.

Returns:: List of health check URL path strings.
Return type:: list[str]

id

BigAutoField

Primary key: ID

Type:: Type

classmethod id_from_hashed_id(hashed_id)

Decodes a hashed ID back to the original object ID.

decoding scheme: 1. Validate that the hashed ID starts with the expected prefix and ends with the expected suffix. 2. Remove the prefix and suffix to isolate the base64-encoded string. 3. Add padding if necessary to make the length of the encoded string a multiple of 4. 4. Decode the base64 string to get the original number as a string. 5. Convert the decoded string to an integer and subtract the HASH_FLOOR to get the original ID.

Example:

my_record = MyModel.objects.create()
print(my_record.id)  # e.g., 123
hashed_id = my_record.hashed_id  # e.g., "rc2x"

original_id = MyModel.id_from_hashed_id(hashed_id)
print(original_id)  # Should print the original ID (e.g., 123)

Parameters:: hashed_id (str) – The hashed ID string to decode (URL-safe, no padding).
Returns:: The original object ID if decoding is successful, otherwise None.
Return type:: Optional[int]

property kind: SAMKinds

Return the kind of the plugin based on its class.

This property is used to determine how the plugin should be handled by the system. It maps the plugin’s class to a corresponding SAMKinds enumeration value.

Returns:: The kind of the plugin as a SAMKinds enum.
Return type:: SAMKinds

Example:

plugin.plugin_class = 'static'
plugin.kind  # SAMKinds.STATIC_PLUGIN

llmclientplugin_set

Reverse ForeignKey from LLMClientPlugin

All LLMClient Plugins of this Plugin (related name of plugin_meta)

Type:: Type

property manifest_url: str

Returns the URL to the plugin’s manifest.

This property constructs the URL to the plugin’s manifest based on its kind and RFC 1034-compliant name. The URL follows the pattern: /plugins/{kind}/{name}/manifest/, where {kind} is the RFC 1034-compliant kind of the plugin, and {name} is the RFC 1034-compliant name of the plugin.

Example:

self.rfc1034_compliant_kind  # 'static'
self.rfc1034_compliant_name  # 'example-plugin
self.manifest_url  # '/plugins/static/example-plugin/manifest/'

mask_string(string='', mask_char='*', mask_length=4, string_length=8)

Masks a string for secure logging.

This utility function masks all but the last unmasked_chars characters of the input string, replacing them with asterisks. It is useful for logging sensitive information like API keys or passwords.

Parameters:

string (Optional[str]) – The string to be masked.
mask_char (str) – The character used for masking.
mask_length (int) – The number of characters to mask.
string_length (int) – The length of the string to consider for masking.

Returns:

The masked string.

Return type:

str

name

CharField

Name. Name in camelCase, e.g., ‘apiKey’, no special characters.

Type:: Type

objects: MetaDataWithOwnershipModelManager = <smarter.apps.account.models.metadata_with_ownership.MetaDataWithOwnershipModelManager object>

property pk

plugin_class

CharField

Plugin class. The class name of the plugin

Choices:

static
sql
api

Type:: Type

plugin_data_base_plugin

Reverse OneToOneField from PluginDataBase

The plugin data base plugin of this Plugin (related name of plugin)

Type:: Type

plugin_prompt_plugin

Reverse OneToOneField from PluginPrompt

The plugin prompt plugin of this Plugin (related name of plugin)

Type:: Type

plugin_selector_plugin

Reverse OneToOneField from PluginSelector

The plugin selector plugin of this Plugin (related name of plugin)

Type:: Type

prepare_database_save(field)

promptpluginusage_set

Reverse ForeignKey from PromptPluginUsage

All Prompt Plugin Usage of this Plugin (related name of plugin)

Type:: Type

prompttoolcall_set

Reverse ForeignKey from PromptToolCall

All Prompt Tool Call History of this Plugin (related name of plugin)

Type:: Type

property ready: bool

Returns True if the plugin is ready to be used.

This property checks if the plugin has all the necessary data and configuration to be considered ready for use. The specific criteria for readiness may depend on the plugin class and other factors, and can be implemented as needed.

Returns:: True if the plugin is ready, False otherwise.
Return type:: bool

property record_locator: str

Returns a short, URL-friendly record locator derived from the object’s ID.

Example:

obj = MyModel.objects.create(name="Example")
print(obj.id)  # e.g., 123
print(obj.record_locator)  # e.g., "llm_client-rc2x"

Returns:: Record locator string (URL-safe, no padding)
Return type:: str

recursive_sort_dict(data)

Recursively sorts a dictionary by its keys.

This method takes a dictionary and returns a new dictionary with all keys sorted in ascending order. If any values are also dictionaries, they will be sorted recursively as well.

Parameters:: data (dict) – The dictionary to sort.
Returns:: A new dictionary with all keys sorted.
Return type:: dict

refresh_from_db(using=None, fields=None, from_queryset=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

rename(new_name)

Rename the model instance with a new name.

Parameters:: new_name (str) – The new name for the instance.
Returns:: The updated instance of MetaDataModel with the new name.
Return type:: MetaDataModel

property rfc1034_compliant_kind: str | None

Returns a URL-friendly kind for the llm_client.

This is a convenience property that returns an RFC 1034-compliant kind for the llm_client, suitable for use in URLs and DNS labels.

Example:

self.kind  # 'Static'
self.rfc1034_compliant_kind  # 'static'

Returns:: The RFC 1034-compliant kind, or None if self.kind is not set.
Return type:: Optional[str]

property rfc1034_compliant_name: str | None

Returns a URL-friendly name for the llm_client.

This property returns an RFC 1034-compliant name for the llm_client, suitable for use in URLs and DNS labels.

Example:

self.name = 'Example LLMClient 1'
self.rfc1034_compliant_name  # 'example-llm_client-1'

Returns:: The RFC 1034-compliant name, or None if self.name is not set.
Return type:: Optional[str]

rfc1034_compliant_str(name)

Converts a string to an RFC 1034 compliant format.

This method takes a string and converts it to a format that complies with RFC 1034, which is commonly used for domain names. It replaces invalid characters with hyphens and ensures the resulting string is lowercase.

Parameters:: name (str) – The string to convert to RFC 1034 compliant format.
Returns:: The converted string in RFC 1034 compliant format.
Return type:: str

rfc1034_compliant_to_snake(name)

Converts an RFC 1034 compliant string to snake_case.

This method takes a string in RFC 1034 compliant format and converts it to snake_case. It replaces hyphens with underscores and ensures the resulting string is lowercase.

Parameters:: name (str) – The RFC 1034 compliant string to convert.
Returns:: The converted string in snake_case.
Return type:: str

save(*args, **kwargs)[source]

Override the save method to validate the field dicts.

This method ensures that all relevant fields are validated before saving the model instance. For example, it checks that the name is in snake_case and converts it if necessary, logs a warning if conversion occurs, and calls the model’s validate() method to enforce any additional validation logic defined on the model. After validation, it proceeds with the standard Django save operation.

Parameters:

args – Positional arguments passed to the parent save method.
kwargs – Keyword arguments passed to the parent save method.

Returns:

None

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

smarter_build_absolute_uri(request)

Attempts to get the absolute URI from a request object.

This utility function tries to retrieve the request URL from any valid child class of django.http.HttpRequest. It is especially useful in unit tests or scenarios where the request object may not implement build_absolute_uri().

Parameters:: request (HttpRequest) – The request object.
Returns:: The absolute request URL.
Return type:: Optional[str]
Raises:: SmarterValueError – If the URI cannot be built from the request.

sorted_dict(data)

Returns a new dictionary with keys sorted.

Parameters:: data (dict) – The dictionary to sort.
Returns:: A new dictionary with sorted keys.
Return type:: dict

tagged_items

Reverse GenericRelation from PluginMeta

All + of this tagged item (related name of tagged_items)

Type:: Type

tags = <taggit.managers._TaggableManager object>

property tags_list: list[str]

Return the tags as a list of strings.

We assume that @cached_property is more efficient at fetch than @cache_results, all things considered equal, which provides a marginal boost to instances. Meanwhile, the @cache_results is persisted to the Django cache, and thus outlives this instance. Thus, best of both worlds.

Returns:: List of tag names.
Return type:: list[str]

to_camel_case(data, convert_values=False)

Converts a snake_case string to camelCase.

This method takes a string in snake_case format and converts it to camelCase. It is useful for standardizing naming conventions across different formats.

Parameters:

data (Union[str, dict[str, object], list[object], object]) – The snake_case string to convert.
convert_values (bool) – Whether to convert the values of dictionaries and lists recursively.

Returns:

The converted string in camelCase.

Return type:

Any

to_json()

Serialize the model instance to a JSON-compatible dictionary.

This method uses the custom SmarterJSONEncoder to ensure that all fields, including timestamps and any complex data types, are properly serialized.

Returns:: A dictionary representation of the model instance suitable for JSON serialization.
Return type:: dict[str, Any]

to_snake_case(data, convert_values=False)

Converts a camelCase or PascalCase string to snake_case.

This method takes a string in camelCase or PascalCase format and converts it to snake_case. It is useful for standardizing naming conventions across different formats.

Parameters:

data (Union[str, dict[str, object], list[object], object]) – The camelCase or PascalCase string to convert.
convert_values (bool) – Whether to convert the values of dictionaries and lists recursively.

Returns:

The converted string in snake_case.

Return type:

Any

property unformatted_class_name: str

Returns the raw class name without formatting.

Returns:: The unformatted class name as a string.
Return type:: str

This is useful for logging or serialization where the plain class name is needed.

unique_error_message(model_class, unique_check)

updated_at

DateTimeField

Updated at

Timestamp indicating when the model instance was last updated.

This field is automatically updated to the current date and time whenever the instance is saved. It is indexed in the database for efficient querying.

Type:: Type

user_profile

ForeignKey to UserProfile

User profile (related name: pluginmeta)

Type:: Type

user_profile_id: Internal field, use user_profile instead.

validate(): Validate the model.

validate_constraints(exclude=None)

validate_unique(exclude=None): Check unique constraints on the model and raise ValidationError if any failed.

version

CharField

Version. Semantic version in the format MAJOR.MINOR.PATCH, e.g., ‘1.0.0’.

Type:: Type