Docs: mention performance reasons for reusing RSAPrivateKey when encoding (#734)

dmahr1 · pre-commit-ci[bot] · web-flow · commit 827d4425dbd2 · 2022-02-15T09:40:36.000+06:00
* Mention reusing RSAPrivateKey for performance reasons * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -45,6 +45,9 @@ If your private key needs a passphrase, you need to pass in a ``PrivateKey`` obj
     )
     encoded = jwt.encode({"some": "payload"}, private_key, algorithm="RS256")
 
+If you are repeatedly encoding with the same private key, reusing the same
+``RSAPrivateKey`` also has performance benefits because it avoids the
+CPU-intensive ``RSA_check_key`` primality test.
 
 Specifying Additional Headers
 -----------------------------

Original file line number	Diff line number	Diff line change
@@ -45,6 +45,9 @@ If your private key needs a passphrase, you need to pass in a ``PrivateKey`` obj
`45`	`45`	`)`
`46`	`46`	`encoded = jwt.encode({"some": "payload"}, private_key, algorithm="RS256")`
`47`	`47`
	`48`	`+If you are repeatedly encoding with the same private key, reusing the same`
	`49`	+``RSAPrivateKey`` also has performance benefits because it avoids the
	`50`	+CPU-intensive ``RSA_check_key`` primality test.
`48`	`51`
`49`	`52`	`Specifying Additional Headers`
`50`	`53`	`-----------------------------`