Git Product home page Git Product logo

azure-sdk-pylint-plugin's Introduction

azure-sdk-pylint-plugin

Investigating how to create pylint plugins/checkers to automate compliance checks for some of the Azure Library for Python design guidelines. The current state of the project is highly experimental. Please don't use any code in this repository as an example on how to write good plugins.

Some ideas on rules:

  • Check for approved method name prefixes (list, get, create etc.)
  • Check API signatures based on prefixes (parameters, including **kwargs/documentation)
  • Check return type/noun used in method name (e.g. list_things should return Thing:s, not Stuff:s)
  • Check class name prefixes
  • Check class name suffixes (use client as suffix - e.g. FooClient)
  • Check canonical pattern (create_configuration, configuration class etc.)
  • Verify that paged implementations follow our protocol
  • Verify that we don't use positional parameters in our code when we have multiple arguments
  • Ensure that we are sync or async "all the way through" for REST calls.
  • Ensure that public APIs log the right things
  • Ensure that exceptions explicitly raised are documented
  • Ensure that exceptions derive from one of the approved exception types
  • Ensure that we have type annotations

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.