Safe Haskell	None
Language	GHC2021

Ecluse.Core.Registry.PyPI.Wire

Contents

Description

Decode PEP 691 metadata with per-entry drops. Raw array positions survive malformed entries so admission and assembly identify the same files.

Synopsis

The media type this shape travels under

The PEP 691 media type used for index requests and responses.

The Simple index

A project's index records malformed file and version entries as drops.

Constructors

SimpleIndex
Fields siName :: Text The project name the index reports, verbatim. Empty when the key is absent. siFiles :: [IndexFile] The offered distribution files, in the order the index listed them. siInvalidEntries :: [InvalidEntry] The malformed `files` and `versions` entries the decode dropped.

Instances details

FromJSON SimpleIndex Source #
Instance details Defined in Ecluse.Core.Registry.PyPI.Wire Methods parseJSON :: Value -> Parser SimpleIndex # parseJSONList :: Value -> Parser [SimpleIndex] # omittedField :: Maybe SimpleIndex #
Show SimpleIndex Source #
Instance details Defined in Ecluse.Core.Registry.PyPI.Wire Methods showsPrec :: Int -> SimpleIndex -> ShowS # show :: SimpleIndex -> String # showList :: [SimpleIndex] -> ShowS #
Eq SimpleIndex Source #
Instance details Defined in Ecluse.Core.Registry.PyPI.Wire Methods (==) :: SimpleIndex -> SimpleIndex -> Bool # (/=) :: SimpleIndex -> SimpleIndex -> Bool #

Refuse malformed or unsupported API declarations. An absent declaration uses the supported API.

A distribution file encodes its release in ifFilename.

Constructors

Fields

ifEntryKey :: EntryKey
ifFilename :: Text
The distribution file name, which encodes the project, the release, and a wheel's tags.
ifUrl :: Text
The file's absolute upstream location, on the ecosystem's files host or the index's own.
ifHashes :: Map Text Text
Unknown digest algorithms drop during projection.
ifRequiresPython :: Maybe Text
The PEP 440 interpreter specifier a client filters on, if the file declares one.
ifSize :: Maybe Int
The file's byte count, if reported. Advisory, so a hostile value reads as absent.
ifUploadTime :: Maybe UTCTime
The per-file publication instant used to compute release age.
ifYanked :: YankState
Whether PEP 592 withdraws this file from resolution, and why.
ifProvenance :: Maybe Text
The URL of a PEP 740 attestation bundle, if the index names one.

Instances details

FromJSON IndexFile Source #
Instance details Defined in Ecluse.Core.Registry.PyPI.Wire Methods parseJSON :: Value -> Parser IndexFile # parseJSONList :: Value -> Parser [IndexFile] # omittedField :: Maybe IndexFile #
Show IndexFile Source #
Instance details Defined in Ecluse.Core.Registry.PyPI.Wire Methods showsPrec :: Int -> IndexFile -> ShowS # show :: IndexFile -> String # showList :: [IndexFile] -> ShowS #
Eq IndexFile Source #
Instance details Defined in Ecluse.Core.Registry.PyPI.Wire Methods (==) :: IndexFile -> IndexFile -> Bool # (/=) :: IndexFile -> IndexFile -> Bool #

A PEP 592 yank withdraws a file from ranges while allowing exact pins.

Constructors

FileOffered	The file resolves normally.
FileWithdrawn (Maybe Text)	The file is withdrawn from resolution, with the reason the index gave.

Instances details

Show YankState Source #
Instance details Defined in Ecluse.Core.Registry.PyPI.Wire Methods showsPrec :: Int -> YankState -> ShowS # show :: YankState -> String # showList :: [YankState] -> ShowS #
Eq YankState Source #
Instance details Defined in Ecluse.Core.Registry.PyPI.Wire Methods (==) :: YankState -> YankState -> Bool # (/=) :: YankState -> YankState -> Bool #

Decode indexed files without renumbering entries that survive lenient parsing.