How to design a library

5b8d20aa7d63c5d391b1c881e1764460?s=47 Iskander (Alex) Sharipov
April 25, 2020
Programming
0
18

How to design a library

Богдан Сторожук.

5b8d20aa7d63c5d391b1c881e1764460?s=128

Iskander (Alex) Sharipov

April 25, 2020
Tweet

More Decks by Iskander (Alex) Sharipov

See All by Iskander (Alex) Sharipov
5b8d20aa7d63c5d391b1c881e1764460?s=48 quasilyte
0
33
5b8d20aa7d63c5d391b1c881e1764460?s=48 quasilyte
0
30
5b8d20aa7d63c5d391b1c881e1764460?s=48 quasilyte
0
9
5b8d20aa7d63c5d391b1c881e1764460?s=48 quasilyte
0
23
5b8d20aa7d63c5d391b1c881e1764460?s=48 quasilyte
1
16
5b8d20aa7d63c5d391b1c881e1764460?s=48 quasilyte
0
11
5b8d20aa7d63c5d391b1c881e1764460?s=48 quasilyte
0
6
5b8d20aa7d63c5d391b1c881e1764460?s=48 quasilyte
0
9
5b8d20aa7d63c5d391b1c881e1764460?s=48 quasilyte
0
10

Other Decks in Programming

See All in Programming
1b863be3048c82d20ea84abcce33dc36?s=48 schktjm
0
170
Bf3acef686273e03fa4fdf125fdad3e9?s=48 kuncevic
0
120
9af444e4e7110845f0b3319efb1ca252?s=48 920oj
1
680
80a3a3857a55f154d23acb705eff72cc?s=48 star_zero
3
140
5c097a7b75c8802b073774faa7276503?s=48 optim
5
360
37618b4d60cf3d1f43f7196253264edc?s=48 numeroanddev
0
160
Faf9deb49f754b79390b64d036725f67?s=48 yuukiyo
1
1.1k
15934fa2aa7b2ce21f091e9b7cffa856?s=48 manfredsteyer
0
230
7eca3e06edc3c69004aaf57de51900c2?s=48 ajstarks
2
310
Aae878e0b108379a60ca627ee262befa?s=48 susanpotter
0
180
C302e84057a922dce0ecbe80207e3fcc?s=48 mu_zaru
1
210
0a98ad166f9cdf8d27d92c37438c6e9d?s=48 matsumana
0
360

Featured

See All Featured
Aff5641764408271f7bc398f2097edd0?s=48 denniskardys
218
110k
Ded01cdab114abe4ec13511e4c25b9bb?s=48 andyhume
60
2.4k
1519587b1a0febb658c36c94f6272b0d?s=48 roundedbygravity
240
20k
C9b18d9dff88a9dd2393364c2b3b21bd?s=48 colly
183
14k
06f8b41980eb4c577fa40c41d5030c19?s=48 keathley
12
440
C51b39fa3c79ccb99dcb8a076bc98287?s=48 brianwarren
83
4.5k
78b475797a14c84799063c7cd073962f?s=48 holman
287
130k
11c84dff30266b907714802088852677?s=48 jasonvnalue
80
7.8k
433acaea1012b25d97ae66da9b998dad?s=48 malarkey
391
60k
F68cb25ae3e5c2106997454b13b7737d?s=48 brad_frost
154
6.1k
E14f55d3f939977cecbf51b64ff6f861?s=48 keithpitt
398
20k
E195ae45320d9202eaa01c9f1d31a416?s=48 marktimemedia
4
74

Transcript

  1. How to please everyone

  2. How to please everyone or random thoughts about library design

  3. What we will talk about

  4. What we will talk about • Design your library API

  5. What we will talk about • Design your library API

    • Make it clear, effective, predictable and transparent

  6. What we will talk about • Design your library API

    • Make it clear, effective, predictable and transparent • Choose between alternative implementations

  7. What we will talk about • Design your library API

    • Make it clear, effective, predictable and transparent • Choose between alternative implementations • Assess your choices

  8. About me

  9. About me

  10. About me

  11. About me

  12. Disclaimer This talk is based on personal experience

  13. Your users

  14. Your users •Regular users

  15. Your users •Regular users •Advanced users

  16. Your users •Regular users •Advanced users •Experts

  17. Your users •Regular users •Advanced users •Experts

  18. Your users •Regular users •Advanced users •Experts

  19. Your users •Regular users •Advanced users •Experts

  20. Regular users

  21. Regular users

  22. Regular users

  23. Regular users

  24. None
  25. None

  26. Example

  27. Example

  28. Example github.com/storozhukBM/verifier

  29. Example github.com/storozhukBM/verifier

  30. copy&paste friendliness • Meaningful method names

  31. copy&paste friendliness • Meaningful method names • Zero configuration

  32. copy&paste friendliness • Meaningful method names • Zero configuration •

    Familiar patterns

  33. copy&paste friendliness • Meaningful method names • Zero configuration •

    Familiar patterns • Testability

  34. copy&paste friendliness • Meaningful method names • Zero configuration •

    Familiar patterns • Testability • No state management

  35. Examples github.com/pkg/errors

  36. Examples github.com/robfig/cron

  37. Examples github.com/robfig/cron

  38. Examples github.com/robfig/cron

  39. Examples github.com/robfig/cron

  40. Examples github.com/robfig/cron

  41. Advanced users

  42. None

  43. Advanced users

  44. Pragmatism friendliness • Meaningful method names • Zero configuration •

    Familiar patterns • Testability • No state management

  45. Pragmatism friendliness • Meaningful method names • Zero configuration Reasonable

    defaults • Familiar patterns • Testability • No state management

  46. Pragmatism friendliness • Meaningful method names • Zero configuration Reasonable

    defaults • Familiar patterns • Testability Introspection • No state management

  47. Pragmatism friendliness • Meaningful method names • Zero configuration Reasonable

    defaults • Familiar patterns • Testability Introspection • No state management (by default)

  48. Optional configuration

  49. Optional configuration github.com/tidwall/buntdb

  50. Optional configuration github.com/tidwall/buntdb

  51. Optional configuration github.com/valyala/fasthttp

  52. Introspection

  53. Introspection github.com/valyala/fasthttp

  54. Introspection github.com/valyala/fasthttp

  55. Introspection github.com/resilience4j/resilience4j

  56. Introspection github.com/resilience4j/resilience4j

  57. Introspection github.com/resilience4j/resilience4j

  58. Introspection github.com/resilience4j/resilience4j

  59. Introspection github.com/resilience4j/resilience4j

  60. Experts

  61. Experts

  62. Experts

  63. Expert friendliness • allocations controll

  64. Expert friendliness • allocations controll • zero-cost abstractions

  65. Expert friendliness • allocations controll • zero-cost abstractions • cost

    modelling

  66. Expert friendliness • allocations controll • zero-cost abstractions • cost

    modelling • paradigm agnostics

  67. Expert friendliness • allocations controll • zero-cost abstractions • cost

    modelling • paradigm agnostics • multi-level API

  68. Tools •Profiler

  69. Tools •Profiler •Tracer

  70. Tools •Profiler •Tracer •Throughput benchmarks

  71. Tools •Profiler •Tracer •Throughput benchmarks •Latency benchmarks

  72. Tools •Profiler •Tracer •Throughput benchmarks •Latency benchmarks •Allocations profiling

  73. Allocations control github.com/storozhukBM/verifier

  74. Allocations control github.com/storozhukBM/verifier

  75. Allocations control github.com/storozhukBM/verifier

  76. Allocations control github.com/storozhukBM/verifier

  77. Zero-cost abstractions “not pay for what you don't use”

  78. Zero-cost abstractions github.com/resilience4j/resilience4j

  79. Zero-cost abstractions github.com/resilience4j/resilience4j

  80. Cost modelling

  81. None
  82. None
  83. None
  84. None

  85. Paradigm agnostics

  86. Paradigm agnostics

  87. Is it even possible? •Regular users •Advanced users •Experts

  88. None
  89. None

  90. Multi-level API

  91. Multi-level API

  92. Multi-level API

  93. Multi-level API

  94. Multi-level API

  95. One more thing

  96. None

  97. One more thing

  98. Backward compatibility

  99. API State Clear Stateless Predictable Transparent Effective Summary

  100. FIN