General¶

Asynchronous Commands¶

Enums¶

ItemType.Gallery == 1 # true
ItemType.Gallery == ItemType.gaLLeRy # true

Exceptions¶

These are errors that HPX may raise. Any error raised not on this list is an unhandled exception and usually classifies as a critical error.

exception HappypandaError(msg)¶

Code: 100

Base Happypanda exception, all exceptions will derive from this.

exception CoreError(where, message)¶

Code: 101

Base Happypanda core exception, all core exceptions will derive from this.

Args:

where: where the error occured message: explanation of error

exception TimeoutError(where, message)¶

Code: 102

Timed out

exception SettingsError(where, message)¶

Code: 110

Base settings error

exception SettingsNoExistError(where, message)¶

Code: 111

Settings doesn’t exist error

exception InvalidSettingError(where, message)¶

Code: 112

Invalid setting error

exception CommandError(where, message)¶

Code: 120

Base command error

exception CommandAlreadyRunningError(where, message)¶

Code: 121

Command is already running

exception ScanError(where, message)¶

Code: 130

Item scan error

exception PluginError(name_or_node, message)¶

Code: 200

Base plugin exception, all plugin exceptions will derive from this.

Args:

name: name of plugin message: explanation of error

exception PluginAttributeError(name_or_node, message)¶

Code: 201

Plugin Attribute Error.

exception PluginCommandError(name_or_node, message)¶

Code: 202

Plugin Command Error.

exception PluginCommandNotFoundError(name_or_node, message)¶

Code: 203

Plugin Command Not Found Error.

exception PluginHandlerError(name_or_node, message)¶

Code: 204

Plugin Handler Error.

exception PluginSignatureError(name_or_node, message)¶

Code: 205

Plugin Signature Error.

exception PluginLoadError(name_or_node, message)¶

Code: 206

Plugin Load Error.

exception PluginInitError(name_or_node, message)¶

Code: 207

Plugin Init Error.

exception PluginInstallError(name_or_node, message)¶

Code: 208

Plugin Install Error.

exception PluginUpdateError(node, *args, **kwargs)¶

Code: 210

Plugin Update No HPlugin Error.

exception PluginUpdateHPluginError(node, *args, **kwargs)¶

Code: 211

Plugin Update HPlugin Error.

exception PluginUpdateInvalidURLError(node, *args, **kwargs)¶

Code: 212

Plugin Update Invalid Url Error.

exception PluginUpdateCheckError(node, *args, **kwargs)¶

Code: 213

Plugin Update Check Error.

exception PluginUpdateDownloadError(node, *args, **kwargs)¶

Code: 214

Plugin Update Down Error.

exception PluginNoHandlerError(name_or_node, message)¶

Code: 215

Plugin No Handler Error.

exception DatabaseError(where, message)¶

Code: 300

Base database exception, all database exceptions will derive from this.

exception DatabaseInitError(msg)¶

Code: 301

Database initialization error.

exception DatabaseVersionError(msg)¶

Code: 302

Database version error.

exception DatabaseItemNotFoundError(where, message)¶

Code: 303

Database item not found error

exception DatabaseDataError(where, message)¶

Code: 304

Database data error

exception EmptyNameError(where, message)¶

Code: 305

Database empty name error

exception ServerError(where, message)¶

Code: 400

Base server exception, all server exceptions will derive from this.

exception ClientDisconnectError(where, message)¶

Code: 401

Client disconnected.

exception InvalidMessage(where, message)¶

Code: 403

Invalid message error.

exception APIError(where, message)¶

Code: 404

API error.

exception APIRequirementError(where, message)¶

Code: 405

API requirement error.

exception AuthError(where, msg)¶

Code: 406

Auth Base Error.

exception AuthRequiredError(where, msg)¶

Code: 407

exception SessionExpiredError(where, session_id)¶

Code: 408

Session expired error.

exception EnumError(where, message)¶

Code: 409

Enum error.

exception ParsingError(where, message)¶

Code: 410

exception AuthWrongCredentialsError(where, msg)¶

Code: 411

exception AuthMissingCredentials(where, msg)¶

Code: 412

exception UserPermissionError(where='', msg='')¶

Code: 413

exception ClientError(name, msg)¶

Code: 500

Base client exception, all client exceptions will derive from this.

Args:

name: name of client msg: error message

exception ConnectionError(name, msg)¶

Code: 501

Server connection error.

exception ServerDisconnectError(name, msg)¶

Code: 502

Server disconnected.

exception ArchiveError(message)¶

Code: 600

Base archive exception, all archive exceptions will derive from this

exception ArchiveCreateError(filepath, error)¶

Code: 601

Could not create archive object

exception ArchiveCorruptError(filepath)¶

Code: 602

Bad file found in archive

exception ArchiveFileNotFoundError(f, archive_f)¶

Code: 603

File not found in archive

exception ArchiveUnsupportedError(f)¶

Code: 604

Unsupported archive

exception ArchiveExtractError(message)¶

Code: 605

Archive extraction error

exception ArchiveExistError(f)¶

Code: 606

Archive does not exist error

exception NotAnArchiveError(f)¶

Code: 607

Not an archive

exception NetworkError(message, properties=None)¶

Code: 700

Base network exception, all network exceptions will derive from this

exception DownloadError(message, properties=None)¶

Code: 750

Base download exception, all download exceptions will derive from this

exception DownloadMoveError(message, properties=None)¶

Code: 751

Failed to move downloaded resource

exception ItemError(where, message, item=None)¶

Code: 800

Base item exception, all item exceptions will derive from this

exception FailedToMoveError(where, message, item=None)¶

Code: 801

Failed to move item source error

exception JSONParseError(json_data, name, msg)¶

Code: 900

JSON parse error.

Guidelines¶

Database¶

Hierarchy¶

Collection -> Grouping -> Gallery -> Page

Note

Grouping is not actually a direct descendant of Collection as can be seen below, but it is sometimes helpful to think of it as such.

Recommended Usage¶

• Collection

  Conventions (e.g. C90), magazine volumes (e.g. Girls forM vol.14), tankōbon’s or a compilation of related/personal galleries

• Grouping

  Think of this as a namespace for related galleries. It is ideal for grouping multi-work galleries, so you use this as the series name. Since tankōbon’s also sometimes feature a complete series, you can use this for that too. It is not recommended to put tankōbon in both Collection and here. Choose one and stick to it to avoid confusion. Gallery’s number field is used in the context of a Grouping.

• GalleryFilter

  Think of this as those smart-playlists in music applications. It’s a compilation of galleries put together by the user either manually or through automatic search filtering. If you’ve used the old Happypanda then you should already be familiar with this. In old HP they were called gallery lists. Recommended usage is “anything”. It could range from your favorite fetishes to a shortcut for a search filter you’re tired of always typing in.

• Gallery

  A single chapter, then you group these chapters under a Grouping to form a complete series.

Special Notes¶

• Gallery

  • A Gallery can have multiple Title, Artist and Parody

  • A Gallery can be in multiple Collection and GalleryFilter

  • A Gallery can only be in one Grouping

  • A Gallery will always be in a Grouping

• Tags

  Gallery and Page are the only taggable items. Collection and Grouping are not taggable, but they can display, and are searchable through tags of their children Gallery.

Alias¶

…

Parent¶

…

Note

You can right-click on the image and choose “Show image” to view it in its full dimensions