Servant.PY.Internal

Documentation

type PythonGenerator = [PythonRequest] -> Text

data ReturnStyle

Constructors

DangerMode

RawResponse

data PythonRequest

Constructors

TypedPythonRequest (Req Text)

UnTypedPythonRequest (Req NoContent)

Instances

Eq PythonRequest

Defined in Servant.PY.Internal

Methods

(==) :: PythonRequest -> PythonRequest -> Bool

(/=) :: PythonRequest -> PythonRequest -> Bool

Show PythonRequest

Defined in Servant.PY.Internal

Methods

showsPrec :: Int -> PythonRequest -> ShowS

show :: PythonRequest -> String

showList :: [PythonRequest] -> ShowS

data PyRequestArgs

Constructors

PyRequestArgs

Fields

• hasHeaders :: Bool
• hasParams :: Bool
• hasData :: Bool

Instances

Show PyRequestArgs

Defined in Servant.PY.Internal

Methods

showsPrec :: Int -> PyRequestArgs -> ShowS

show :: PyRequestArgs -> String

showList :: [PyRequestArgs] -> ShowS

data CommonGeneratorOptions

This structure is used by specific implementations to let you customize the output

Constructors

CommonGeneratorOptions

Fields

• functionNameBuilder :: FunctionName -> Text

  function generating function names

• requestBody :: Text

  name used when a user want to send the request body (to let you redefine it)

• urlPrefix :: Text

  a prefix we should add to the Url in the codegen

• indentation :: Proxy Indent -> Text

  indentation to use for Python codeblocks. Create this function by passing an Int to indenter.

• returnMode :: ReturnStyle

  whether the generated functions return the raw response or content

defCommonGeneratorOptions :: CommonGeneratorOptions

Default options.

> defCommonGeneratorOptions = CommonGeneratorOptions
>   { functionNameBuilder = snakeCase
>   , requestBody = "body"
>   , urlPrefix = ""
>   , indentation = "    "  -- 4 spaces
>   , returnMode = DangerMode
>   }

defaultPyIndent :: Proxy Indent -> Text

indent :: Proxy Indent

type Indent = (" " :: Symbol)

indenter :: Int -> Proxy Indent -> Text

makePyUrl :: CommonGeneratorOptions -> PythonRequest -> Text -> Text

makePyUrl' :: forall f. CommonGeneratorOptions -> Req f -> Text -> Text

segmentToStr :: Segment f -> Text

capturesToFormatArgs :: [Segment f] -> [Text]

toValidFunctionName :: Text -> Text

Attempts to reduce the function name provided to that allowed by Foreign.

For valid Python function identifiers see the following: https://docs.python.org/3.2/reference/lexical_analysis.html#identifiers valid start chars: Lu, Ll, Lt, Lm, Lo, Nl, the underscore valid continuation chars: valid start chars <> Mn, Mc, Nd, Pc

functionName :: CommonGeneratorOptions -> PythonRequest -> Text

toPyHeader :: HeaderArg f -> Text

retrieveHeaders :: PythonRequest -> [Text]

getHeaderDict :: PythonRequest -> Text

retrieveHeaderText :: forall f. HeaderArg f -> Text

toPyDict :: Text -> [Text] -> Text

toPyParams :: Text -> [QueryArg f] -> Text

getParams :: Text -> PythonRequest -> Text

paramNames :: PythonRequest -> [Text]

captures :: PythonRequest -> [Text]

getMethod :: PythonRequest -> Text

hasBody :: PythonRequest -> Bool

withFormattedCaptures :: Text -> [Segment f] -> Text

buildDocString :: PythonRequest -> CommonGeneratorOptions -> Text -> Text

buildHeaderDict :: [HeaderArg f] -> Text

functionArguments :: forall f. Req f -> Text

formatBuilder :: Text -> Text

remainingReqCall :: PyRequestArgs -> Int -> Text