Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • N nxcals
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
  • Jira
    • Jira
  • Merge requests 9
    • Merge requests 9
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • acc-logging-team
  • nxcals
  • Merge requests
  • !1571

WIP: NXCALS-6470 Generate type hint stubs for NXCALS API

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Vito Baggiolini requested to merge feature/NXCALS-6470-Generate-type-hint-stubs-for-NXCALS-API into feature-NXCALS-6893-integrate_py4j_stubs_and_imports_with_nxcals Aug 09, 2022
  • Overview 48
  • Commits 63
  • Pipelines 21
  • Changes 10

Merge request template

COMPATIBILITY NOTE

Please make sure that this change is BACKWARDS COMPATIBLE and a new server will work correctly with clients using old APIs versions.

It may be that data sent in the new format will break the old clients.

In case of any potential incompatibility we have to inform our clients and schedule release & deployment with them.


@acc-logging-team - please have a look for approval.

This MR is essentially the translation of the shell script generate_stubs.sh into a build.gradle script. Things to review (amongst others):

  • build.gradle script - structure, code style, ...
  • possibility of using the installer for the acc-py distribution downloaded with http (no need for NFS access)
  • Where to get all the Jars that are needed to generate stubs? Currently I do copyLibs in nxcals-extraction-api
  • where to put the resulting sdist wheel file (is ./dist/ OK)?
  • whether to silence the tasks (if possible) or keep sometimes verbose output in the logs

TODO:

  • add some kind of tests, possibly with MyPy?

Closes NXCALS-6470

Edited Aug 23, 2022 by Vito Baggiolini
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: feature/NXCALS-6470-Generate-type-hint-stubs-for-NXCALS-API